adderlib.channels module

class adderlib.channels.AdderChannel(properties: dict)

Bases: object

Adderlink channel

class ButtonState(value)

Bases: enum.Enum

Video-only mode capabilities

DISABLED = 'disabled'
ENABLED = 'enabled'
HIDDEN = 'hidden'
UNKNOWN = 'unknown'
class ConnectionMode(value)

Bases: enum.Enum

An enumeration.

EXCLUSIVE = 'e'
PRIVATE = 'p'
SHARED = 's'
VIEW_ONLY = 'v'
property control_available: bool

Whether the user may view in video-only mode

property control_button: adderlib.channels.AdderChannel.ButtonState

Indicates the state of the full-control button

property description: str

Channel description

property exclusive_available: bool

Whether the user may view in video-only mode

property exclusive_button: adderlib.channels.AdderChannel.ButtonState

Indicates the state of the video-only view button

property id: str

Channel ID

property is_favorite: bool

Whether the channel has been favorited

property is_online: bool

Device status

property location: str

Channel location

property name: str

Channel name

property shared_available: bool

Whether the user may view in shared mode

property shared_button: adderlib.channels.AdderChannel.ButtonState

Indicates the state of the shared view button

property shortcut: str

Returns the shortcut index if set

property tx_id: str

Device ID

property type: str

Channel type

property view_available: bool

Whether the user may view in video-only mode

property view_button: adderlib.channels.AdderChannel.ButtonState

Indicates the state of the video-only view button