Class

PurpleMedia

Description [src] 

class Purple.Media : GObject.Object {
  parent: GObject
}

The media instance.

Ancestors

Instance methods

purple_media_accepted

Gets whether a streams selected have been accepted.

since: 2.6

purple_media_add_remote_candidates

Adds remote candidates to the stream.

since: 2.6

purple_media_add_stream

Adds a stream to a session.

since: 2.6

purple_media_candidates_prepared

Returns whether or not the candidates for set of streams are prepared.

since: 2.6

purple_media_codecs_ready

Gets whether a session’s codecs are ready to be used.

since: 2.6

purple_media_end

Ends all streams that match the given parameters.

since: 2.6

purple_media_error

Signals an error in the media session.

since: 2.6

purple_media_get_account

Gets the PurpleAccount this media session is on.

since: 2.6

purple_media_get_active_local_candidates

Gets the active local candidates for the stream.

since: 2.8

purple_media_get_active_remote_candidates

Gets the active remote candidates for the stream.

since: 2.8

purple_media_get_available_params

Gets the list of optional parameters supported by the media backend.

since: 2.8

purple_media_get_codecs

Gets the codecs from a session.

since: 2.6

purple_media_get_local_candidates

Gets the local candidates from a stream.

since: 2.6

purple_media_get_manager

Gets the PurpleMediaManager this media session is a part of.

since: 2.6

purple_media_get_protocol_data

Gets the protocol data from the media session.

since: 3.0

purple_media_get_session_ids

Gets a list of session IDs.

since: 2.6

purple_media_get_session_type

Gets the session type from a session.

since: 2.6

purple_media_get_src

Gets the source from a session.

since: 2.6

purple_media_get_tee

Gets the tee from a given session/stream.

since: 2.6

purple_media_is_initiator

Gets whether the local user is the conference/session/stream’s initiator.

since: 2.6

purple_media_param_is_supported

Checks if given optional parameter is supported by the media backend.

since: 2.8

purple_media_remove_output_windows

Removes all output windows from a given media session.

since: 2.6

purple_media_send_dtmf

Sends a DTMF signal out-of-band.

since: 2.11

purple_media_set_decryption_parameters

Sets the decryption parameters for a session participant’s media.

since: 2.11

purple_media_set_encryption_parameters

Sets the encryption parameters of our media in the session.

since: 2.11

purple_media_set_input_volume

Sets the input volume of all the selected sessions.

since: 2.6

purple_media_set_output_volume

Sets the output volume of all the selected streams.

since: 2.6

purple_media_set_output_window

Sets a video output window for the given session/stream.

since: 2.6

purple_media_set_params

Sets various optional parameters of the media call.

since: 2.8

purple_media_set_protocol_data

Sets the protocol data on the media session.

since: 3.0

purple_media_set_remote_codecs

Sets remote codecs from the stream.

since: 2.6

purple_media_set_require_encryption

Sets whether a session participant’s media requires encryption.

since: 2.14

purple_media_set_send_codec

Sets the send codec for the a session.

since: 2.6

purple_media_set_send_rtcp_mux

Sets the rtcp-mux option for the stream.

since: 2.11

purple_media_stream_info

Signals different information about the given stream.

since: 2.6

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Media:account

The PurpleAccount that this media belongs to.

Purple.Media:backend

The backend for this media.

Purple.Media:conference-type

The conference type of this media.

Purple.Media:initiator

Whether or not the local user initiated the conference.

Purple.Media:manager

The manager that this media is tied to.

Purple.Media:protocol-data

Protocol specific data for the media.

Signals

Purple.Media::candidate-pair-established

Emitted when candidates have been established for a session.

Purple.Media::candidates-prepared

Emitted when a candidate element has been determined.

Purple.Media::codecs-changed

Emitted when the codecs have changed.

Purple.Media::error

Emitted by purple_media_error().

Purple.Media::level

Emitted when the volume of a participant has changed. I think?

Purple.Media::new-candidate

Emitted when a new media candidate is available.

Purple.Media::state-changed

Emitted when the media’s state has changed.

Purple.Media::stream-info

Emitted when information about the stream is available.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct PurpleMediaClass {
  GObjectClass parent_class;
  void (* purple_reserved1) (
void
  );
  void (* purple_reserved2) (
void
  );
  void (* purple_reserved3) (
void
  );
  void (* purple_reserved4) (
void
  );
  
}

The media class.

Class members
parent_class: GObjectClass
No description available.
purple_reserved1: void (* purple_reserved1) ( void )
No description available.
purple_reserved2: void (* purple_reserved2) ( void )
No description available.
purple_reserved3: void (* purple_reserved3) ( void )
No description available.
purple_reserved4: void (* purple_reserved4) ( void )
No description available.