TelepathyGLib.CallChannel¶

Subclasses:: None

Methods¶

Inherited:: TelepathyGLib.Channel (44), TelepathyGLib.Proxy (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_feature_quark_core` ()
	`accept_async` (callback, *user_data)
	`accept_finish` (result)
	`add_content_async` (name, type, initial_direction, callback, *user_data)
	`add_content_finish` (result)
	`get_contents` ()
	`get_members` ()
	`get_state` ()
	`hangup_async` (reason, detailed_reason, message, callback, *user_data)
	`hangup_finish` (result)
	`has_dtmf` ()
	`has_hardware_streaming` ()
	`has_hold` ()
	`has_initial_audio` ()
	`has_initial_video` ()
	`has_mutable_contents` ()
	`request_hold_async` (hold, callback, *user_data)
	`request_hold_finish` (result)
	`send_tones_async` (tones, cancellable, callback, *user_data)
	`send_tones_finish` (result)
	`set_queued_async` (callback, *user_data)
	`set_queued_finish` (result)
	`set_ringing_async` (callback, *user_data)
	`set_ringing_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: TelepathyGLib.Channel (12), TelepathyGLib.Proxy (5)

Name	Type	Flags	Short Description
`contents`	`GLib.PtrArray`	r	The content objects of this call
`flags`	`int`	r	The flags of the call
`hardware-streaming`	`bool`	r	Hardware streaming
`hold-state`	`int`	r	The Hold state of the call
`hold-state-reason`	`int`	r	The reason for the current hold state
`initial-audio`	`bool`	r	Initial audio
`initial-audio-name`	`str`	r	Initial audio name
`initial-video`	`bool`	r	Initial video
`initial-video-name`	`str`	r	Initial video name
`mutable-contents`	`bool`	r	Mutable contents
`state`	`int`	r	The state of the call
`state-details`	`GLib.HashTable`	r	The details of the call
`state-reason`	`TelepathyGLib.CallStateReason`	r	The reason of the call’s state

Signals¶

Inherited:: TelepathyGLib.Channel (5), TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Short Description
`content-added`	The `::content-added` signal is emitted whenever a `TelepathyGLib.CallContent` is added to self.
`content-removed`	The `::content-removed` signal is emitted whenever a `TelepathyGLib.CallContent` is removed from self.
`members-changed`	The `::members-changed` signal is emitted whenever the call’s members changes.
`state-changed`	The `::state-changed` signal is emitted whenever the call state changes.

Fields¶

Inherited:: TelepathyGLib.Channel (5), TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Type	Access	Description
parent	`TelepathyGLib.Channel`	r

Class Details¶

class TelepathyGLib.CallChannel(**kwargs)¶

Bases:: TelepathyGLib.Channel
Abstract:: No
Structure:: TelepathyGLib.CallChannelClass

Data structure representing a TelepathyGLib.CallChannel.

New in version 0.17.5.

classmethod get_feature_quark_core()¶

Return type:: int

accept_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

For incoming calls with TelepathyGLib.CallChannel :state set to TelepathyGLib.CallState.INITIALISED, accept the incoming call. This changes TelepathyGLib.CallChannel :state to TelepathyGLib.CallState.ACCEPTED.

For outgoing calls with TelepathyGLib.CallChannel :state set to TelepathyGLib.CallState.PENDING_INITIATOR, actually call the remote contact; this changes TelepathyGLib.CallChannel :state to TelepathyGLib.CallState.INITIALISING.

New in version 0.17.5.

accept_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Return type:: bool

Finishes TelepathyGLib.CallChannel.accept_async().

New in version 0.17.5.

add_content_async(name, type, initial_direction, callback, *user_data)¶

Parameters:

name (str) – the suggested name of the content to add
type (TelepathyGLib.MediaStreamType) – the media stream type of the content to be added to the call, from TelepathyGLib.MediaStreamType
initial_direction (TelepathyGLib.MediaStreamDirection) – The initial direction of the content
callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Request that a new Content of type type is added to self. Callers should check the value of the TelepathyGLib.CallChannel :mutable-contents property before trying to add another content as it might not be allowed.

New in version 0.17.5.

add_content_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: reference to the new TelepathyGLib.CallContent.
Return type:: TelepathyGLib.CallContent

Finishes TelepathyGLib.CallChannel.add_content_async().

The returned TelepathyGLib.CallContent is NOT guaranteed to have %TP_CALL_CONTENT_FEATURE_CORE prepared.

New in version 0.17.5.

get_contents()¶

Returns:: the value of TelepathyGLib.CallChannel :contents
Return type:: [TelepathyGLib.CallContent]

New in version 0.17.5.

get_members()¶

Returns:: GLib.HashTable mapping TelepathyGLib.Contact to its new TelepathyGLib.CallMemberFlags
Return type:: {TelepathyGLib.Contact: int}

Get the members of this call.

The TelepathyGLib.Contact objects are guaranteed to have all of the features previously passed to TelepathyGLib.SimpleClientFactory.add_contact_features() prepared.

New in version 0.17.5.

get_state()¶

Returns:

the value of TelepathyGLib.CallChannel :state

flags:: a place to set the value of TelepathyGLib.CallChannel :flags
details:: a place to set the value of TelepathyGLib.CallChannel :state-details
reason:: a place to set the value of TelepathyGLib.CallChannel :state-reason

Return type:

(TelepathyGLib.CallState, flags: TelepathyGLib.CallFlags, details: {object: object}, reason: TelepathyGLib.CallStateReason)

New in version 0.17.5.

hangup_async(reason, detailed_reason, message, callback, *user_data)¶

Parameters:

reason (TelepathyGLib.CallStateChangeReason) – a TelepathyGLib.CallStateChangeReason
detailed_reason (str) – a more specific reason for the call hangup, if one is available, or an empty or None string otherwise
message (str) – a human-readable message to be sent to the remote contact(s)
callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Request that the call is ended. All contents will be removed from self so that the TelepathyGLib.CallChannel :contents property will be the empty list.

New in version 0.17.5.

hangup_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Return type:: bool

Finishes TelepathyGLib.CallChannel.hangup_async().

New in version 0.17.5.

has_dtmf()¶

Returns:: whether or not self can send DTMF tones.
Return type:: bool

Whether or not self can send DTMF tones using TelepathyGLib.CallChannel.send_tones_async(). To be able to send DTMF tones, at least one of self's TelepathyGLib.CallChannel :contents must implement TelepathyGLib.IFACE_CALL_CONTENT_INTERFACE_DTMF interface.

New in version 0.17.5.

has_hardware_streaming()¶

Returns:: the value of TelepathyGLib.CallChannel :hardware-streaming
Return type:: bool

New in version 0.17.5.

has_hold()¶

Returns:: whether or not self supports Hold
Return type:: bool

Whether or not self has the TelepathyGLib.IFACE_CHANNEL_INTERFACE_HOLD interfaces

New in version 0.17.6.

has_initial_audio()¶

Returns:

the value of TelepathyGLib.CallChannel :initial-audio

initial_audio_name:: a place to set the value of TelepathyGLib.CallChannel :initial-audio-name

Return type:

(bool, initial_audio_name: str)

New in version 0.17.5.

has_initial_video()¶

Returns:

the value of TelepathyGLib.CallChannel :initial-video

initial_video_name:: a place to set the value of TelepathyGLib.CallChannel :initial-video-name

Return type:

(bool, initial_video_name: str)

New in version 0.17.5.

has_mutable_contents()¶

Returns:: the value of TelepathyGLib.CallChannel :mutable-contents
Return type:: bool

New in version 0.17.5.

request_hold_async(hold, callback, *user_data)¶

Parameters:

hold (bool) – Whether to request a hold or a unhold
callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Requests that the connection manager holds or unholds the call. Watch TelepathyGLib.CallChannel :hold-state property to know when the channel goes on hold or is unheld. Unholding may fail if the streaming implementation can not obtain all the resources needed to restart the call.

New in version 0.17.6.

request_hold_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Return type:: bool

Finishes TelepathyGLib.CallChannel.request_hold_async

New in version 0.17.6.

send_tones_async(tones, cancellable, callback, *user_data)¶

Parameters:

tones (str) – a string representation of one or more DTMF events.
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore
callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Send tones on every of self's contents which have the TelepathyGLib.IFACE_CALL_CONTENT_INTERFACE_DTMF interface.

For more details, see TelepathyGLib.CallContent.send_tones_async().

New in version 0.17.5.

send_tones_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True on success, False otherwise.
Return type:: bool

Finishes TelepathyGLib.CallChannel.send_tones_async().

New in version 0.17.5.

set_queued_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Notifies the CM that the local user is already in a call, so this call has been put in a call-waiting style queue.

New in version 0.17.5.

set_queued_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Return type:: bool

Finishes TelepathyGLib.CallChannel.set_queued_async().

New in version 0.17.5.

set_ringing_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – a callback to call when the operation finishes
user_data (object or None) – data to pass to callback

Indicate that the local user has been alerted about the incoming call.

New in version 0.17.5.

set_ringing_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Return type:: bool

Finishes TelepathyGLib.CallChannel.set_ringing_async().

New in version 0.17.5.

Signal Details¶

TelepathyGLib.CallChannel.signals.content_added(call_channel, content)¶

Signal Name:

content-added

Flags:

RUN_LAST

Parameters:

call_channel (TelepathyGLib.CallChannel) – The object which received the signal
content (GObject.Object) – the newly added TelepathyGLib.CallContent

The ::content-added signal is emitted whenever a TelepathyGLib.CallContent is added to self.

It is NOT guaranteed that %TP_CALL_CONTENT_FEATURE_CORE is prepared on content.

New in version 0.17.5.

TelepathyGLib.CallChannel.signals.content_removed(call_channel, content, reason)¶

Signal Name:

content-removed

Flags:

RUN_LAST

Parameters:

call_channel (TelepathyGLib.CallChannel) – The object which received the signal
content (GObject.Object) – the newly removed TelepathyGLib.CallContent
reason (TelepathyGLib.CallStateReason) – a TelepathyGLib.CallStateReason

The ::content-removed signal is emitted whenever a TelepathyGLib.CallContent is removed from self.

It is NOT guaranteed that %TP_CALL_CONTENT_FEATURE_CORE is prepared on content.

New in version 0.17.5.

TelepathyGLib.CallChannel.signals.members_changed(call_channel, updates, removed, reason)¶

Signal Name:

members-changed

Flags:

RUN_LAST

Parameters:

call_channel (TelepathyGLib.CallChannel) – The object which received the signal
updates ({TelepathyGLib.Contact: int}) – GLib.HashTable mapping TelepathyGLib.Contact to its new TelepathyGLib.CallMemberFlags
removed ([TelepathyGLib.Contact]) – GLib.PtrArray of TelepathyGLib.Contact removed from the call members
reason (TelepathyGLib.CallStateReason) – the TelepathyGLib.CallStateReason for the change

The ::members-changed signal is emitted whenever the call’s members changes.

The TelepathyGLib.Contact objects are guaranteed to have all of the features previously passed to TelepathyGLib.SimpleClientFactory.add_contact_features() prepared.

New in version 0.17.5.

TelepathyGLib.CallChannel.signals.state_changed(call_channel, state, flags, reason, details)¶

Signal Name:

state-changed

Flags:

RUN_LAST

Parameters:

call_channel (TelepathyGLib.CallChannel) – The object which received the signal
state (int) – the new TelepathyGLib.CallState
flags (int) – the new TelepathyGLib.CallFlags
reason (TelepathyGLib.CallStateReason) – the TelepathyGLib.CallStateReason for the change
details ({str: GObject.Value}) – additional details as a GLib.HashTable readable using the tp_asv_* functions.

The ::state-changed signal is emitted whenever the call state changes.

New in version 0.17.5.

Property Details¶

TelepathyGLib.CallChannel.props.contents¶

Name:: contents
Type:: GLib.PtrArray
Default Value:: None
Flags:: READABLE

GLib.PtrArray of TelepathyGLib.CallContent objects. The list of content objects that are part of this call.

It is NOT guaranteed that %TP_CALL_CONTENT_FEATURE_CORE is prepared on those objects.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.flags¶

Name:: flags
Type:: int
Default Value:: 0
Flags:: READABLE

A TelepathyGLib.CallFlags specifying the flags of the call state.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.hardware_streaming¶

Name:: hardware-streaming
Type:: bool
Default Value:: False
Flags:: READABLE

Whether or not the streaming is done by dedicated hardware.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.hold_state¶

Name:: hold-state
Type:: int
Default Value:: 0
Flags:: READABLE

A TelepathyGLib.LocalHoldState specifying if the Call is currently held

New in version 0.17.6.

TelepathyGLib.CallChannel.props.hold_state_reason¶

Name:: hold-state-reason
Type:: int
Default Value:: 0
Flags:: READABLE

A TelepathyGLib.LocalHoldStateReason specifying why the Call is currently held.

New in version 0.17.6.

TelepathyGLib.CallChannel.props.initial_audio¶

Name:: initial-audio
Type:: bool
Default Value:: False
Flags:: READABLE

Whether or not the Call was started with audio.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.initial_audio_name¶

Name:: initial-audio-name
Type:: str
Default Value:: None
Flags:: READABLE

If TelepathyGLib.CallChannel :initial-audio is set to True, then this property will is the name of the intial audio content, None otherwise.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.initial_video¶

Name:: initial-video
Type:: bool
Default Value:: False
Flags:: READABLE

Whether or not the Call was started with video.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.initial_video_name¶

Name:: initial-video-name
Type:: str
Default Value:: None
Flags:: READABLE

If TelepathyGLib.CallChannel :initial-video is set to True, then this property will is the name of the intial video content, None otherwise.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.mutable_contents¶

Name:: mutable-contents
Type:: bool
Default Value:: False
Flags:: READABLE

Whether or not call contents can be added or removed.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.state¶

Name:: state
Type:: int
Default Value:: 0
Flags:: READABLE

A TelepathyGLib.CallState specifying the state of the call.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.state_details¶

Name:: state-details
Type:: GLib.HashTable
Default Value:: None
Flags:: READABLE

Detailed infoermation about TelepathyGLib.CallChannel :state. It is a GLib.HashTable mapping str->:obj:GObject.Value, it can be accessed using the tp_asv_* functions.

New in version 0.17.5.

TelepathyGLib.CallChannel.props.state_reason¶

Name:: state-reason
Type:: TelepathyGLib.CallStateReason
Default Value:: None
Flags:: READABLE

Reason why TelepathyGLib.CallChannel :state last changed.

New in version 0.17.5.