Interface

PurpleProtocolMedia

Description [src]

interface Purple.ProtocolMedia : Purple.Protocol

PurpleProtocolMedia describes the multimedia api that is available for protocols.

Prerequisite

In order to implement ProtocolMedia, your type must inherit from PurpleProtocol.

Instance methods

purple_protocol_media_get_caps

Gets the PurpleMediaCaps for who which determine what types of media are available.

Available since: 3.0.0

purple_protocol_media_initiate_session

Initiates a media connection of type to who.

Available since: 3.0.0

purple_protocol_media_send_dtmf

Sends a DTMF (dual-tone multi-frequency) signal via the established media for the given duration at the given volume.

Available since: 3.0.0

Interface structure

struct PurpleProtocolMediaInterface {
  gboolean (* initiate_session) (
    PurpleProtocolMedia* media,
    PurpleAccount* account,
    const gchar* who,
    PurpleMediaSessionType type
  );
  PurpleMediaCaps (* get_caps) (
    PurpleProtocolMedia* media,
    PurpleAccount* account,
    const gchar* who
  );
  gboolean (* send_dtmf) (
    PurpleProtocolMedia* protocol_media,
    PurpleMedia* media,
    gchar dtmf,
    guint8 volume,
    guint8 duration
  );
  
}

The protocol media interface.

This interface provides callbacks for media sessions on the protocol.

Interface members
initiate_session
gboolean (* initiate_session) (
    PurpleProtocolMedia* media,
    PurpleAccount* account,
    const gchar* who,
    PurpleMediaSessionType type
  )
 No description available.
get_caps
PurpleMediaCaps (* get_caps) (
    PurpleProtocolMedia* media,
    PurpleAccount* account,
    const gchar* who
  )
 No description available.
send_dtmf
gboolean (* send_dtmf) (
    PurpleProtocolMedia* protocol_media,
    PurpleMedia* media,
    gchar dtmf,
    guint8 volume,
    guint8 duration
  )
 No description available.

Virtual methods

Purple.ProtocolMedia.get_caps

Gets the PurpleMediaCaps for who which determine what types of media are available.

Purple.ProtocolMedia.initiate_session

Initiates a media connection of type to who.

Purple.ProtocolMedia.send_dtmf

Sends a DTMF (dual-tone multi-frequency) signal via the established media for the given duration at the given volume.