Farstream.Transmitter

g Farstream.Transmitter Farstream.Transmitter GObject.Object GObject.Object GObject.Object->Farstream.Transmitter

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class list_available ()
class new (type, components, tos)
  emit_error (error_no, error_msg)
  get_stream_transmitter_type ()
  new_stream_transmitter (participant, n_parameters, parameters)

Virtual Methods

Inherited:GObject.Object (7)
  do_get_stream_transmitter_type ()
  do_new_stream_transmitter (participant, n_parameters, parameters)

Properties

Name Type Flags Short Description
components int r/w/co The number of components to create
do-timestamp bool r/w Apply current stream time to buffers
gst-sink Gst.Element r A source Gst.Element to be used by a Farstream.Session
gst-src Gst.Element r A source Gst.Element to be used by a Farstream.Session
tos int r/w The IP Type of Service to set on sent packets

Signals

Inherited:GObject.Object (1)
Name Short Description
error This signal is emitted in any error condition

Fields

Inherited:GObject.Object (1)
Name Type Access Description
construction_error GLib.Error r  
parent GObject.Object r  

Class Details

class Farstream.Transmitter(**kwargs)
Bases:GObject.Object
Abstract:Yes
Structure:Farstream.TransmitterClass

All members are private, access them using methods and properties

classmethod list_available()
Returns:a newly allocated array of strings containing the list of all available transmitters or None if there are none. It should be freed with GLib.strfreev().
Return type:[str]

Get the list of all available transmitters

classmethod new(type, components, tos)
Parameters:
  • type (str) – The type of transmitter to create
  • components (int) – The number of components to create
  • tos (int) – The Type of Service of the socket, max is 255
Raises:

GLib.Error

Returns:

a newly-created Farstream.Transmitter of the requested type (or None if there is an error)

Return type:

Farstream.Transmitter

This function creates a new transmitter of the requested type. It will load the appropriate plugin as required.

emit_error(error_no, error_msg)
Parameters:
  • error_no (int) – The number of the error
  • error_msg (str) – Error message to be displayed to user

This function emit the “error” signal on a Farstream.Transmitter, it should only be called by subclasses.

get_stream_transmitter_type()
Returns:the GObject.GType
Return type:GObject.GType

This function returns the GObject.Object type for the stream transmitter. This is meant for bindings that need to introspect the type of arguments that can be passed to the _new_stream_transmitter.

new_stream_transmitter(participant, n_parameters, parameters)
Parameters:
Raises:

GLib.Error

Returns:

a new Farstream.StreamTransmitter, or None if there is an error

Return type:

Farstream.StreamTransmitter

This function will create a new Farstream.StreamTransmitter element for a specific participant for this Farstream.Transmitter

do_get_stream_transmitter_type() virtual
Returns:the GObject.GType
Return type:GObject.GType

This function returns the GObject.Object type for the stream transmitter. This is meant for bindings that need to introspect the type of arguments that can be passed to the _new_stream_transmitter.

do_new_stream_transmitter(participant, n_parameters, parameters) virtual
Parameters:
Returns:

a new Farstream.StreamTransmitter, or None if there is an error

Return type:

Farstream.StreamTransmitter

This function will create a new Farstream.StreamTransmitter element for a specific participant for this Farstream.Transmitter

Signal Details

Farstream.Transmitter.signals.error(transmitter, errorno, error_msg)
Signal Name:

error

Flags:

RUN_LAST

Parameters:

This signal is emitted in any error condition

Property Details

Farstream.Transmitter.props.components
Name:components
Type:int
Default Value:1
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The number of components to create

Farstream.Transmitter.props.do_timestamp
Name:do-timestamp
Type:bool
Default Value:True
Flags:READABLE, WRITABLE

Apply current stream time to buffers or provide buffers without timestamps. Must be set before creating a stream transmitter.

Farstream.Transmitter.props.gst_sink
Name:gst-sink
Type:Gst.Element
Default Value:None
Flags:READABLE

A network source Gst.Element to be used by the Farstream.Session These element’s sink must have async=:obj:False This element MUST provide a pad named “sink_\%u” per component. These pads number must start at 1 (the \%u corresponds to the component number). These pads MUST be static pads.

Farstream.Transmitter.props.gst_src
Name:gst-src
Type:Gst.Element
Default Value:None
Flags:READABLE

A network source Gst.Element to be used by the Farstream.Session This element MUST provide a source pad named “src_%u” per component. These pads number must start at 1 (the %u corresponds to the component number). These pads MUST be static pads.

Farstream.Transmitter.props.tos
Name:tos
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Sets the IP ToS field (and if possible the IPv6 TCLASS field