TelepathyGLib.CallStream¶

Subclasses:: None

Methods¶

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

class	`get_feature_quark_core` ()
class	`init_known_interfaces` ()
	`can_request_receiving` ()
	`get_local_sending_state` ()
	`get_remote_members` ()
	`request_receiving_async` (contact, receive, callback, *user_data)
	`request_receiving_finish` (result)
	`set_sending_async` (send, callback, *user_data)
	`set_sending_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: TelepathyGLib.Proxy (5)

Name	Type	Flags	Short Description
`can-request-receiving`	`bool`	r	If true, the user can request that a remote contact starts sending onthis stream.
`connection`	`TelepathyGLib.Connection`	r/w/co	The connection of this stream
`content`	`TelepathyGLib.CallContent`	r/w/co	The content that this Stream belongs to
`local-sending-state`	`int`	r	Local sending state

Signals¶

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

Name	Short Description
`local-sending-state-changed`	The `::local-sending-state-changed` signal is emitted whenever the stream sending state changes.
`remote-members-changed`	The `::remote-members-changed` signal is emitted whenever the stream’s remote members changes.

Fields¶

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

Name	Type	Access	Description
parent	`TelepathyGLib.Proxy`	r

Class Details¶

class TelepathyGLib.CallStream(**kwargs)¶

Bases:: TelepathyGLib.Proxy
Abstract:: No
Structure:: TelepathyGLib.CallStreamClass

Data structure representing a TelepathyGLib.CallStream.

New in version 0.17.5.

classmethod get_feature_quark_core()¶

Return type:: int

classmethod init_known_interfaces()¶: Ensure that the known interfaces for TelepathyGLib.CallStream have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument %TP_TYPE_CALL_STREAM.

New in version 0.17.5.

can_request_receiving()¶

Returns:: the value of TelepathyGLib.CallStream :can-request-receiving
Return type:: bool

New in version 0.17.5.

get_local_sending_state()¶

Returns:: the value of TelepathyGLib.CallStream :local-sending-state
Return type:: TelepathyGLib.SendingState

New in version 0.17.5.

get_remote_members()¶

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

Get the remote contacts to who this stream is connected, mapped to their sending state.

It is NOT guaranteed that TelepathyGLib.Contact objects have any feature prepared.

New in version 0.17.5.

request_receiving_async(contact, receive, callback, *user_data)¶

Parameters:

contact (TelepathyGLib.Contact) – contact from which sending is requested
receive (bool) – the requested receiving state
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 remote contact stops or starts sending on this stream.

The TelepathyGLib.CallStream :can-request-receiving property defines whether the protocol allows the local user to request the other side start sending on this stream.

If receive is True, request that the given contact starts to send media. If receive is False, request that the given contact stops sending media.

New in version 0.17.5.

request_receiving_finish(result)¶

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

Finishes TelepathyGLib.CallStream.request_receiving_async().

New in version 0.17.5.

set_sending_async(send, callback, *user_data)¶

Parameters:

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

Set the stream to start or stop sending media from the local user to other contacts.

If send is True, TelepathyGLib.CallStream :local-sending-state should change to TelepathyGLib.SendingState.SENDING, if it isn’t already. If send is False, TelepathyGLib.CallStream :local-sending-state should change to TelepathyGLib.SendingState.NONE, if it isn’t already.

New in version 0.17.5.

set_sending_finish(result)¶

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

Finishes TelepathyGLib.CallStream.set_sending_async().

New in version 0.17.5.

Signal Details¶

TelepathyGLib.CallStream.signals.local_sending_state_changed(call_stream, state, reason)¶

Signal Name:

local-sending-state-changed

Flags:

RUN_LAST

Parameters:

call_stream (TelepathyGLib.CallStream) – The object which received the signal
state (int) – the new TelepathyGLib.SendingState
reason (TelepathyGLib.CallStateReason) – the TelepathyGLib.CallStateReason for the change

The ::local-sending-state-changed signal is emitted whenever the stream sending state changes.

New in version 0.17.5.

TelepathyGLib.CallStream.signals.remote_members_changed(call_stream, updates, removed, reason)¶

Signal Name:

remote-members-changed

Flags:

RUN_LAST

Parameters:

call_stream (TelepathyGLib.CallStream) – The object which received the signal
updates ({TelepathyGLib.Contact: int}) – GLib.HashTable mapping TelepathyGLib.Contact to its new TelepathyGLib.SendingState
removed ([TelepathyGLib.Contact]) – GLib.PtrArray of TelepathyGLib.Contact removed from remote contacts
reason (TelepathyGLib.CallStateReason) – the TelepathyGLib.CallStateReason for the change

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

It is NOT guaranteed that TelepathyGLib.Contact objects have any feature prepared.

New in version 0.17.5.

Property Details¶

TelepathyGLib.CallStream.props.can_request_receiving¶

Name:: can-request-receiving
Type:: bool
Default Value:: False
Flags:: READABLE

If True, the user can request that a remote contact starts sending on this stream.

New in version 0.17.5.

TelepathyGLib.CallStream.props.connection¶

Name:: connection
Type:: TelepathyGLib.Connection
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The TelepathyGLib.Connection of the call.

New in version 0.17.5.

TelepathyGLib.CallStream.props.content¶

Name:: content
Type:: TelepathyGLib.CallContent
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Content that this streams belongs to

New in version 0.17.6.

TelepathyGLib.CallStream.props.local_sending_state¶

Name:: local-sending-state
Type:: int
Default Value:: 0
Flags:: READABLE

The local user’s sending state, from TelepathyGLib.SendingState.

New in version 0.17.5.