MatrixEventCallInvite

MatrixEventCallInvite — This event is sent by the caller when they wish to establish a call.

Functions

Types and Values

Description

Functions

MATRIX_EVENT_TYPE_CALL_INVITE

#define MATRIX_EVENT_TYPE_CALL_INVITE (matrix_event_call_invite_get_type ())

The type for MatrixEventCallInvite.


matrix_event_call_invite_new ()

MatrixEventCallInvite *
matrix_event_call_invite_new (void);

matrix_event_call_invite_get_offer_type ()

MatrixCallOfferType
matrix_event_call_invite_get_offer_type
                               (MatrixEventCallInvite *self);

Get and return the current value of the "offer-type" property.

The type of session description.

Parameters

self

the MatrixEventCallInvite instance to query

 

Returns

the value of the "offer-type" property


matrix_event_call_invite_set_offer_type ()

void
matrix_event_call_invite_set_offer_type
                               (MatrixEventCallInvite *self,
                                MatrixCallOfferType value);

Set the value of the "offer-type" property to value .

The type of session description.

Parameters

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "offer-type" property

 

matrix_event_call_invite_get_sdp ()

const gchar *
matrix_event_call_invite_get_sdp (MatrixEventCallInvite *self);

Get and return the current value of the "sdp" property.

The SDP text of the session description.

Parameters

self

the MatrixEventCallInvite instance to query

 

Returns

the value of the "sdp" property


matrix_event_call_invite_set_sdp ()

void
matrix_event_call_invite_set_sdp (MatrixEventCallInvite *self,
                                  const gchar *value);

Set the value of the "sdp" property to value .

The SDP text of the session description.

Parameters

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "sdp" property

 

matrix_event_call_invite_get_lifetime ()

gint
matrix_event_call_invite_get_lifetime (MatrixEventCallInvite *self);

Get and return the current value of the "lifetime" property.

The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

Parameters

self

the MatrixEventCallInvite instance to query

 

Returns

the value of the "lifetime" property


matrix_event_call_invite_set_lifetime ()

void
matrix_event_call_invite_set_lifetime (MatrixEventCallInvite *self,
                                       gint value);

Set the value of the "lifetime" property to value .

The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

Parameters

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "lifetime" property

 

Types and Values

struct MatrixEventCallInvite

struct MatrixEventCallInvite {
	MatrixEventCall parent_instance;
	MatrixEventCallInvitePrivate * priv;
};

This event is sent by the caller when they wish to establish a call.


struct MatrixEventCallInviteClass

struct MatrixEventCallInviteClass {
	MatrixEventCallClass parent_class;
};

The class structure for MATRIX_EVENT_TYPE_CALL_INVITE. All the fields in this structure are private and should never be accessed directly.

Members

MatrixEventCallClass parent_class;

the parent class structure