GstPoll

Gst.Poll

Gst.Poll.prototype.add_fd

function Gst.Poll.prototype.add_fd(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_add_fd'
}

Add a file descriptor to the file descriptor set.

Gst.Poll.prototype.fd_can_read

function Gst.Poll.prototype.fd_can_read(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_can_read'
}

Check if fd in set has data to be read.

Gst.Poll.prototype.fd_can_write

function Gst.Poll.prototype.fd_can_write(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_can_write'
}

Check if fd in set can be used for writing.

Gst.Poll.prototype.fd_ctl_pri

function Gst.Poll.prototype.fd_ctl_pri(fd: Gst.PollFD, active: Number): {
    // javascript wrapper for 'gst_poll_fd_ctl_pri'
}

Control whether the descriptor fd in set will be monitored for exceptional conditions (POLLPRI).

Not implemented on Windows (will just return false there).

Since : 1.16

Gst.Poll.prototype.fd_ctl_read

function Gst.Poll.prototype.fd_ctl_read(fd: Gst.PollFD, active: Number): {
    // javascript wrapper for 'gst_poll_fd_ctl_read'
}

Control whether the descriptor fd in set will be monitored for readability.

Gst.Poll.prototype.fd_ctl_write

function Gst.Poll.prototype.fd_ctl_write(fd: Gst.PollFD, active: Number): {
    // javascript wrapper for 'gst_poll_fd_ctl_write'
}

Control whether the descriptor fd in set will be monitored for writability.

Gst.Poll.prototype.fd_has_closed

function Gst.Poll.prototype.fd_has_closed(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_has_closed'
}

Check if fd in set has closed the connection.

Gst.Poll.prototype.fd_has_error

function Gst.Poll.prototype.fd_has_error(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_has_error'
}

Check if fd in set has an error.

Gst.Poll.prototype.fd_has_pri

function Gst.Poll.prototype.fd_has_pri(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_has_pri'
}

Check if fd in set has an exceptional condition (POLLPRI).

Not implemented on Windows (will just return false there).

Since : 1.16

Gst.Poll.prototype.fd_ignored

function Gst.Poll.prototype.fd_ignored(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_fd_ignored'
}

Mark fd as ignored so that the next call to Gst.Poll.prototype.wait will yield the same result for fd as last time. This function must be called if no operation (read/write/recv/send/etc.) will be performed on fd before the next call to Gst.Poll.prototype.wait.

The reason why this is needed is because the underlying implementation might not allow querying the fd more than once between calls to one of the re-enabling operations.

Gst.Poll.prototype.free

function Gst.Poll.prototype.free(): {
    // javascript wrapper for 'gst_poll_free'
}

Free a file descriptor set.

Gst.Poll.prototype.get_read_gpollfd

function Gst.Poll.prototype.get_read_gpollfd(fd: GPollFD (not introspectable)): {
    // javascript wrapper for 'gst_poll_get_read_gpollfd'
}

Get a GPollFD for the reading part of the control socket. This is useful when integrating with a GSource and GMainLoop.

Gst.Poll.prototype.read_control

function Gst.Poll.prototype.read_control(): {
    // javascript wrapper for 'gst_poll_read_control'
}

Read a byte from the control socket of the controllable set.

This function only works for timer Gst.Poll objects created with gst_poll_new_timer (not introspectable).

Gst.Poll.prototype.remove_fd

function Gst.Poll.prototype.remove_fd(fd: Gst.PollFD): {
    // javascript wrapper for 'gst_poll_remove_fd'
}

Remove a file descriptor from the file descriptor set.

Gst.Poll.prototype.restart

function Gst.Poll.prototype.restart(): {
    // javascript wrapper for 'gst_poll_restart'
}

Restart any Gst.Poll.prototype.wait that is in progress. This function is typically used after adding or removing descriptors to set.

If set is not controllable, then this call will have no effect.

This function only works for non-timer Gst.Poll objects created with gst_poll_new (not introspectable).

Gst.Poll.prototype.set_controllable

function Gst.Poll.prototype.set_controllable(controllable: Number): {
    // javascript wrapper for 'gst_poll_set_controllable'
}

When controllable is true, this function ensures that future calls to Gst.Poll.prototype.wait will be affected by Gst.Poll.prototype.restart and Gst.Poll.prototype.set_flushing.

This function only works for non-timer Gst.Poll objects created with gst_poll_new (not introspectable).

Gst.Poll.prototype.set_flushing

function Gst.Poll.prototype.set_flushing(flushing: Number): {
    // javascript wrapper for 'gst_poll_set_flushing'
}

When flushing is true, this function ensures that current and future calls to Gst.Poll.prototype.wait will return -1, with errno set to EBUSY.

Unsetting the flushing state will restore normal operation of set.

This function only works for non-timer Gst.Poll objects created with gst_poll_new (not introspectable).

Gst.Poll.prototype.wait

function Gst.Poll.prototype.wait(timeout: Number): {
    // javascript wrapper for 'gst_poll_wait'
}

Wait for activity on the file descriptors in set. This function waits up to the specified timeout. A timeout of Gst.CLOCK_TIME_NONE waits forever.

For Gst.Poll objects created with gst_poll_new (not introspectable), this function can only be called from a single thread at a time. If called from multiple threads, -1 will be returned with errno set to EPERM.

This is not true for timer Gst.Poll objects created with gst_poll_new_timer (not introspectable), where it is allowed to have multiple threads waiting simultaneously.

Gst.Poll.prototype.write_control

function Gst.Poll.prototype.write_control(): {
    // javascript wrapper for 'gst_poll_write_control'
}

Write a byte to the control socket of the controllable set. This function is mostly useful for timer Gst.Poll objects created with gst_poll_new_timer (not introspectable).

It will make any current and future Gst.Poll.prototype.wait function return with 1, meaning the control socket is set. After an equal amount of calls to Gst.Poll.prototype.read_control have been performed, calls to Gst.Poll.prototype.wait will block again until their timeout expired.

This function only works for timer Gst.Poll objects created with gst_poll_new_timer (not introspectable).

Gst.PollFD

Gst.PollFD.prototype.init

function Gst.PollFD.prototype.init(): {
    // javascript wrapper for 'gst_poll_fd_init'
}

Initializes fd. Alternatively you can initialize it with GST_POLL_FD_INIT (not introspectable).