OwrMediaSession

OwrMediaSession — OwrMediaSession

Functions

OwrMediaSession * owr_media_session_new ()
void owr_media_session_add_receive_payload ()
void owr_media_session_set_send_payload ()
void owr_media_session_set_send_source ()

Properties

gchar * cname Read
gchar * incoming-srtp-key Read / Write
guint jitter-buffer-latency Read / Write
gchar * outgoing-srtp-key Read / Write
gboolean rtcp-mux Read / Write
guint send-ssrc Read

Signals

void on-incoming-source Cleanup
void on-new-stats Cleanup

Types and Values

struct OwrMediaSessionClass

Object Hierarchy

    GObject
    ╰── OwrSession
        ╰── OwrMediaSession

Description

OwrMediaSession - Represents one incoming and one outgoing media stream.

Functions

owr_media_session_new ()

OwrMediaSession *
owr_media_session_new (gboolean dtls_client_mode);

Constructs the OwrMediaSession object.

Parameters

dtls_client_mode

TRUE if the connection for the session should be setup using DTLS client role

  

Returns

the created media session

owr_media_session_add_receive_payload ()

void
owr_media_session_add_receive_payload (OwrMediaSession *media_session,
                                       OwrPayload *payload);

The function adds support for receiving the given payload type.

Parameters

media_session

the media session on which to add the receive payload.

  

payload

the receive payload to add.

[transfer full]

owr_media_session_set_send_payload ()

void
owr_media_session_set_send_payload (OwrMediaSession *media_session,
                                    OwrPayload *payload);

Sets what payload that will be sent.

Parameters

media_session

The media session on which set the send payload.

  

payload

the send payload to set.

[transfer full][allow-none]

owr_media_session_set_send_source ()

void
owr_media_session_set_send_source (OwrMediaSession *media_session,
                                   OwrMediaSource *source);

Sets the source from which data will be sent.

Parameters

media_session

The media session on which to set the send source.

  

source

the send source to set.

[transfer none][allow-none]

Types and Values

struct OwrMediaSessionClass

struct OwrMediaSessionClass {
    OwrSessionClass parent_class;

    /* signals */
    void (*on_new_stats)(OwrMediaSession *media_session, GHashTable *stats);
    void (*on_incoming_source)(OwrMediaSession *media_session, OwrRemoteMediaSource *source);
};

The session class.

Members

OwrSessionClass parent_class;

the GObject parent

  

on_new_stats ()

emitted when there's new stats

  

on_incoming_source ()

emitted to notify of a new incoming source

  

Property Details

The “cname” property

  “cname”                    gchar *

The canonical name identifying this endpoint.

Flags: Read

Default value: NULL

The “incoming-srtp-key” property

  “incoming-srtp-key”        gchar *

Key used to decrypt incoming SRTP packets (base64 encoded).

Flags: Read / Write

Default value: NULL

The “jitter-buffer-latency” property

  “jitter-buffer-latency”    guint

The latency introduced by the jitter buffer for this session in ms.

Flags: Read / Write

Default value: 50

The “outgoing-srtp-key” property

  “outgoing-srtp-key”        gchar *

Key used to encrypt outgoing SRTP packets (base64 encoded).

Flags: Read / Write

Default value: NULL

The “rtcp-mux” property

  “rtcp-mux”                 gboolean

Whether to use RTP/RTCP multiplexing or not. Once RTP/RTCP multiplexing has been enabled, it cannot be disabled again.

Flags: Read / Write

Default value: FALSE

The “send-ssrc” property

  “send-ssrc”                guint

The ssrc used for the outgoing RTP media stream.

Flags: Read

Default value: 0

Signal Details

The “on-incoming-source” signal

void
user_function (OwrMediaSession      *media_session,
               OwrRemoteMediaSource *source,
               gpointer              user_data)

Notify of a new incoming source for a OwrMediaSession.

Parameters

media_session

the object which received the signal

  

source

the new incoming source.

[transfer none]

user_data

user data set when the signal handler was connected.

  

Flags: Cleanup

The “on-new-stats” signal

void
user_function (OwrMediaSession *media_session,
               GHashTable      *stats,
               gpointer         user_data)

Notify of new stats for a OwrMediaSession.

Parameters

media_session

the OwrMediaSession object which received the signal

  

stats

the stats GHashTable.

[element-type utf8 GValue][transfer none]

user_data

user data set when the signal handler was connected.

  

Flags: Cleanup

Generated by GTK-Doc V1.21