WpSessionItem Interfaces

Wp.SiEndpoint

Wp.SiEndpoint.prototype.get_n_streams

function Wp.SiEndpoint.prototype.get_n_streams(): {
    // javascript wrapper for 'wp_si_endpoint_get_n_streams'
}

Wp.SiEndpoint.prototype.get_properties

function Wp.SiEndpoint.prototype.get_properties(): {
    // javascript wrapper for 'wp_si_endpoint_get_properties'
}

Wp.SiEndpoint.prototype.get_registration_info

function Wp.SiEndpoint.prototype.get_registration_info(): {
    // javascript wrapper for 'wp_si_endpoint_get_registration_info'
}

This should return information that is used for registering the endpoint, as a GVariant tuple of type (ssya{ss}) that contains, in order:

• s: the endpoint's name
• s: the media class
• y: the direction
• a{ss}: additional properties to be added to the list of global properties

Wp.SiEndpoint.prototype.get_stream

function Wp.SiEndpoint.prototype.get_stream(index: Number): {
    // javascript wrapper for 'wp_si_endpoint_get_stream'
}

Wp.SiEndpoint.prototype.get_stream_acquisition

function Wp.SiEndpoint.prototype.get_stream_acquisition(): {
    // javascript wrapper for 'wp_si_endpoint_get_stream_acquisition'
}

endpoint-properties-changed

function endpoint_properties_changed_callback(self: Wp.SiEndpoint, user_data: Object): {
    // javascript callback for the 'endpoint-properties-changed' signal
}

Flags: Run Last

endpoint-streams-changed

function endpoint_streams_changed_callback(self: Wp.SiEndpoint, user_data: Object): {
    // javascript callback for the 'endpoint-streams-changed' signal
}

Flags: Run Last

vfunc_get_n_streams

function vfunc_get_n_streams(self: Wp.SiEndpoint): {
    // javascript implementation of the 'get_n_streams' virtual method
}

vfunc_get_properties

function vfunc_get_properties(self: Wp.SiEndpoint): {
    // javascript implementation of the 'get_properties' virtual method
}

vfunc_get_registration_info

function vfunc_get_registration_info(self: Wp.SiEndpoint): {
    // javascript implementation of the 'get_registration_info' virtual method
}

vfunc_get_stream

function vfunc_get_stream(self: Wp.SiEndpoint, index: Number): {
    // javascript implementation of the 'get_stream' virtual method
}

vfunc_get_stream_acquisition

function vfunc_get_stream_acquisition(self: Wp.SiEndpoint): {
    // javascript implementation of the 'get_stream_acquisition' virtual method
}

Wp.SiLink

Wp.SiLink.prototype.get_in_stream

function Wp.SiLink.prototype.get_in_stream(): {
    // javascript wrapper for 'wp_si_link_get_in_stream'
}

Wp.SiLink.prototype.get_out_stream

function Wp.SiLink.prototype.get_out_stream(): {
    // javascript wrapper for 'wp_si_link_get_out_stream'
}

Wp.SiLink.prototype.get_properties

function Wp.SiLink.prototype.get_properties(): {
    // javascript wrapper for 'wp_si_link_get_properties'
}

Wp.SiLink.prototype.get_registration_info

function Wp.SiLink.prototype.get_registration_info(): {
    // javascript wrapper for 'wp_si_link_get_registration_info'
}

This should return information that is used for registering the link, as a GVariant of type a{ss} that contains additional properties to be added to the list of global properties

link-properties-changed

function link_properties_changed_callback(self: Wp.SiLink, user_data: Object): {
    // javascript callback for the 'link-properties-changed' signal
}

Flags: Run Last

vfunc_get_in_stream

function vfunc_get_in_stream(self: Wp.SiLink): {
    // javascript implementation of the 'get_in_stream' virtual method
}

vfunc_get_out_stream

function vfunc_get_out_stream(self: Wp.SiLink): {
    // javascript implementation of the 'get_out_stream' virtual method
}

vfunc_get_properties

function vfunc_get_properties(self: Wp.SiLink): {
    // javascript implementation of the 'get_properties' virtual method
}

vfunc_get_registration_info

function vfunc_get_registration_info(self: Wp.SiLink): {
    // javascript implementation of the 'get_registration_info' virtual method
}

Wp.SiPortInfo

Wp.SiPortInfo.prototype.get_ports

function Wp.SiPortInfo.prototype.get_ports(context: String): {
    // javascript wrapper for 'wp_si_port_info_get_ports'
}

This method returns a variant of type "a(uuu)", where each tuple in the array contains the following information:

• u: (guint32) node id
• u: (guint32) port id (the port must belong on the node specified above)
• u: (guint32) the audio channel (enum spa_audio_channel) that this port makes available, or 0 for non-audio content

The order in which ports appear in this array is important when no channel information is available. The link implementation should link the ports in the order they appear. This is normally a good enough substitute for channel matching.

The context argument can be used to get different sets of ports from the item. The following well-known contexts are defined:

• null: get the standard ports to be linked
• "monitor": get the monitor ports
• "control": get the control port
• "reverse": get the reverse direction ports, if this item controls a filter node, which would have ports on both directions

Contexts other than null may only be used internally to ease the implementation of more complex endpoint relationships. For example, a Wp.SessionItem that is in control of an input (sink) adapter node may implement Wp.SiStream and Wp.SiPortInfo where the null context will return the standard input ports and the "monitor" context will return the adapter's monitor ports. When linking this stream to another stream, the null context will always be used, but the item may internally spawn a secondary Wp.SessionItem that implements the "monitor" endpoint & stream. That secondary stream may implement Wp.SiPortInfo, chaining calls to the Wp.SiPortInfo of the original item using the "monitor" context. This way, the monitor Wp.SessionItem does not need to share control of the underlying node; it only proxies calls to satisfy the API.

vfunc_get_ports

function vfunc_get_ports(self: Wp.SiPortInfo, context: String): {
    // javascript implementation of the 'get_ports' virtual method
}

Wp.SiStream

Wp.SiStream.prototype.get_parent_endpoint

function Wp.SiStream.prototype.get_parent_endpoint(): {
    // javascript wrapper for 'wp_si_stream_get_parent_endpoint'
}

Wp.SiStream.prototype.get_properties

function Wp.SiStream.prototype.get_properties(): {
    // javascript wrapper for 'wp_si_stream_get_properties'
}

Wp.SiStream.prototype.get_registration_info

function Wp.SiStream.prototype.get_registration_info(): {
    // javascript wrapper for 'wp_si_stream_get_registration_info'
}

This should return information that is used for registering the stream, as a GVariant tuple of type (sa{ss}) that contains, in order:

• s: the stream's name
• a{ss}: additional properties to be added to the list of global properties

stream-properties-changed

function stream_properties_changed_callback(self: Wp.SiStream, user_data: Object): {
    // javascript callback for the 'stream-properties-changed' signal
}

Flags: Run Last

vfunc_get_parent_endpoint

function vfunc_get_parent_endpoint(self: Wp.SiStream): {
    // javascript implementation of the 'get_parent_endpoint' virtual method
}

vfunc_get_properties

function vfunc_get_properties(self: Wp.SiStream): {
    // javascript implementation of the 'get_properties' virtual method
}

vfunc_get_registration_info

function vfunc_get_registration_info(self: Wp.SiStream): {
    // javascript implementation of the 'get_registration_info' virtual method
}

Wp.SiStreamAcquisition

Wp.SiStreamAcquisition.prototype.acquire

function Wp.SiStreamAcquisition.prototype.acquire(acquisitor: Wp.SiLink, stream: Wp.SiStream, callback: Gio.AsyncReadyCallback, data: Object): {
    // javascript wrapper for 'wp_si_stream_acquisition_acquire'
}

Acquires the stream for linking by acquisitor.

When a link is not allowed by policy, this operation should return an error.

When a link needs to be delayed for a short amount of time (ex. to apply a fade out effect on another stream), this operation should finish with a delay. It is safe to assume that after this operation completes, the stream will be linked immediately.

Wp.SiStreamAcquisition.prototype.acquire_finish

function Wp.SiStreamAcquisition.prototype.acquire_finish(res: Gio.AsyncResult): {
    // javascript wrapper for 'wp_si_stream_acquisition_acquire_finish'
}

Finishes the operation started by Wp.SiStreamAcquisition.prototype.acquire. This is meant to be called in the callback that was passed to that method.

Wp.SiStreamAcquisition.prototype.release

function Wp.SiStreamAcquisition.prototype.release(acquisitor: Wp.SiLink, stream: Wp.SiStream): {
    // javascript wrapper for 'wp_si_stream_acquisition_release'
}

Releases the stream, which means that it is being unlinked.

vfunc_acquire

function vfunc_acquire(self: Wp.SiStreamAcquisition, acquisitor: Wp.SiLink, stream: Wp.SiStream, callback: Gio.AsyncReadyCallback, data: Object): {
    // javascript implementation of the 'acquire' virtual method
}

vfunc_acquire_finish

function vfunc_acquire_finish(self: Wp.SiStreamAcquisition, res: Gio.AsyncResult): {
    // javascript implementation of the 'acquire_finish' virtual method
}

vfunc_release

function vfunc_release(self: Wp.SiStreamAcquisition, acquisitor: Wp.SiLink, stream: Wp.SiStream): {
    // javascript implementation of the 'release' virtual method
}