MatrixEventCallCandidates

MatrixEventCallCandidates — This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.

Functions

Types and Values

Description

Functions

MATRIX_EVENT_TYPE_CALL_CANDIDATES

#define MATRIX_EVENT_TYPE_CALL_CANDIDATES (matrix_event_call_candidates_get_type ())

The type for MatrixEventCallCandidates.


matrix_event_call_candidates_new ()

MatrixEventCallCandidates *
matrix_event_call_candidates_new (void);

matrix_event_call_candidates_get_candidates ()

MatrixEventCallCandidatesCandidate *
matrix_event_call_candidates_get_candidates
                               (MatrixEventCallCandidates *self,
                                int *result_length1);

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

The list of candidates.

Parameters

self

the MatrixEventCallCandidates instance to query

 

Returns

the value of the "candidates" property


matrix_event_call_candidates_set_candidates ()

void
matrix_event_call_candidates_set_candidates
                               (MatrixEventCallCandidates *self,
                                MatrixEventCallCandidatesCandidate *value,
                                int value_length1);

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

The list of candidates.

Parameters

self

the MatrixEventCallCandidates instance to modify

 

value

the new value of the "candidates" property

 

matrix_event_call_candidates_candidate_dup ()

MatrixEventCallCandidatesCandidate *
matrix_event_call_candidates_candidate_dup
                               (const MatrixEventCallCandidatesCandidate *self);

Creates a copy of self.

See also: matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_destroy(), matrix_event_call_candidates_candidate_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with matrix_event_call_candidates_candidate_free()


matrix_event_call_candidates_candidate_free ()

void
matrix_event_call_candidates_candidate_free
                               (MatrixEventCallCandidatesCandidate *self);

Frees the heap-allocated struct.

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_destroy()

Parameters

self

the struct to free

 

matrix_event_call_candidates_candidate_copy ()

void
matrix_event_call_candidates_candidate_copy
                               (const MatrixEventCallCandidatesCandidate *self,
                                MatrixEventCallCandidatesCandidate *dest);

Creates a copy of self.

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_destroy(), matrix_event_call_candidates_candidate_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use matrix_event_call_candidates_candidate_destroy() to free the content.

 

matrix_event_call_candidates_candidate_destroy ()

void
matrix_event_call_candidates_candidate_destroy
                               (MatrixEventCallCandidatesCandidate *self);

Frees the content of the struct pointed by self .

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_free()

Parameters

self

the struct to destroy

 

Types and Values

struct MatrixEventCallCandidatesCandidate

struct MatrixEventCallCandidatesCandidate {
	gchar* sdp_mid;
	gint* sdp_line_index;
	gchar* candidate;
};

struct MatrixEventCallCandidates

struct MatrixEventCallCandidates {
	MatrixEventCall parent_instance;
	MatrixEventCallCandidatesPrivate * priv;
};

This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.


struct MatrixEventCallCandidatesClass

struct MatrixEventCallCandidatesClass {
	MatrixEventCallClass parent_class;
};

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

Members

MatrixEventCallClass parent_class;

the parent class structure