Interface Call.Content.DRAFT

Interface Index (Compact) | Summary | Description | Methods | Signals | Properties | Types

Methods

Remove (u: Reason, s: Detailed_Removal_Reason, s: Message) → nothing

Signals

Removed ()
StreamsAdded (ao: Streams)
StreamsRemoved (ao: Streams)

Properties

Interfaces as (DBus_Interface_List) Read only Immutable
Name s Read only Immutable
Type u (Media_Stream_Type) Read only Immutable
Disposition u (Call_Content_Disposition) Read only Immutable
Streams ao Read only

Types

Content_Removal_Reason Enum u
Call_Content_Disposition Enum u
WARNING: This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.
Added in 0.19.0. (draft 1)

Description

This object represents one Content inside a Call.DRAFT. For example, in an audio/video call there would be one audio content and one video content. Each content has one or more Stream.DRAFT objects which represent the actual transport to one or more remote contacts.

Methods

(Permalink)

Remove (u: Reason, s: Detailed_Removal_Reason, s: Message) → nothing

Changed in 0.21.2. previously there were no arguments

Parameters

  • Reason — u (Content_Removal_Reason)
    • A generic hangup reason.
  • Detailed_Removal_Reason — s (DBus_Error_Name)
    • A more specific reason for the content removal, if one is available, or an empty string.
  • Message — s
    • A human-readable message for the reason of removing the content, such as "Fatal streaming failure" or "no codec intersection". This property can be left empty if no reason is to be given.
Remove the content from the call.

Possible Errors

  • Network Error
    • Raised when there is an error reading from or writing to the network.
  • Not Implemented
    • Raised when a Call doesn't support removing contents (e.g. a Google Talk video call).

Signals

(Permalink)

Removed ()

Emitted when the content is removed from the call. This is the same as the Call.DRAFT.ContentRemoved signal.

(Permalink)

StreamsAdded (ao: Streams)

Changed in 0.21.2. plural version, renamed from StreamAdded

Parameters

Emitted when streams are added to a call.

(Permalink)

StreamsRemoved (ao: Streams)

Changed in 0.21.2. plural version, renamed from StreamRemoved

Parameters

Emitted when streams are removed from a call

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

Interfaces — as (DBus_Interface_List)

Read only
This property is immutable which means that it can never change.
Added in 0.19.11.

Extra interfaces provided by this content, such as Content.Interface.Media.DRAFT or Content.Interface.Mute.DRAFT. This SHOULD NOT include the Content interface itself, and cannot change once the content has been created.

(Permalink)

Name — s

Read only
This property is immutable which means that it can never change.

The name of the content.

Rationale:
The content name property should be meaningful, so should be given a name which is significant to the user. The name could be the "audio" or "video" string localized, or perhaps include some string identifying the source, such as a webcam identifier.
(Permalink)

Type — u (Media_Stream_Type)

Read only
This property is immutable which means that it can never change.

The media type of this content.

(Permalink)

Disposition — u (Call_Content_Disposition)

Read only
This property is immutable which means that it can never change.
The disposition of this content.
(Permalink)

Streams — ao

Read only

The list of Stream.DRAFT objects that exist in this content.

Rationale:
In a conference call multiple parties can share one media content (say, audio), but the streaming of that media can either be shared or separate. For example, in a multicast conference all contacts would share one stream, while in a Muji conference there would be a stream for each participant.

Change notification is through the StreamsAdded and StreamsRemoved signals.

Types

Enum (Permalink)

Content_Removal_Reason — u

Added in 0.21.2.
A representation of the reason for a content to be removed, which may be used by simple clients, or used as a fallback when the DBus_Reason is not understood. This enum will be extended with future reasons as and when appropriate, so clients SHOULD keep up to date with its values, but also be happy to fallback to the Unknown value when an unknown value is encountered.
  • Unknown (0)
    • We just don't know. Unknown values of this enum SHOULD also be treated like this.
  • User_Requested (1)

    • The local user requests that this content is removed from the call.

  • Error (2)

    • There is an error with the content which means that it has to be removed from the call.

  • Unsupported (3)

    • Some aspect of the content is unsupported so has to be removed from the call.

Enum (Permalink)

Call_Content_Disposition — u

The disposition of this content, which defines whether to automatically start sending data on the streams when Call.DRAFT is called on the channel.
  • None (0)
    • The content has no specific disposition
  • Initial (1)

    • The content was initially part of the call. When Accept is called on the channel, all streams of this content with LocalSendingState set to Sending_State_Pending_Send will be moved to Sending_State_Sending as if SetSending (True) had been called.