Method

PurpleMediaadd_stream

since: 2.6

Declaration [src]

gboolean
purple_media_add_stream (
  PurpleMedia* media,
  const gchar* sess_id,
  const gchar* who,
  PurpleMediaSessionType type,
  gboolean initiator,
  const gchar* transmitter,
  GHashTable* params
)

Description [src]

Adds a stream to a session.

It only adds a stream to one audio session or video session as the sess_id must be unique between sessions.

Available since: 2.6

Parameters

sess_id

Type: const gchar*

The session id of the session to add the stream to.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
who

Type: const gchar*

The name of the remote user to add the stream for.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
type

Type: PurpleMediaSessionType

The type of stream to create.

initiator

Type: gboolean

Whether or not the local user initiated the stream.

transmitter

Type: const gchar*

The transmitter to use for the stream.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
params

Type: GHashTable

The stream parameters to pass to Farstream.

The data is owned by the caller of the function.

Return value

Type: gboolean

TRUE The stream was added successfully, FALSE otherwise.