ContentLauncher

Attributes

class st.matter.clusters.ContentLauncher.AcceptHeader

ID: number: 0x0000 the ID of this attribute

NAME: str: “AcceptHeader” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptHeader(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptHeader => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptHeader test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ContentLauncher.SupportedStreamingProtocols

ID: number: 0x0001 the ID of this attribute

NAME: str: “SupportedStreamingProtocols” the name of this attribute

data_type: st.matter.generated.zap_clusters.ContentLauncher.types.SupportedProtocolsBitmap: the data type of this attribute

new_value(...)

Create a SupportedProtocolsBitmap object of this attribute with any additional features provided for the attribute

This is also usable with the SupportedStreamingProtocols(…) syntax

Parameters: vararg (vararg) – the values needed to construct a SupportedProtocolsBitmap
Return type: st.matter.generated.zap_clusters.ContentLauncher.types.SupportedProtocolsBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SupportedStreamingProtocols => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an SupportedStreamingProtocols test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ContentLauncher.AcceptedCommandList

ID: number: 0xFFF9 the ID of this attribute

NAME: str: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ContentLauncher.EventList

ID: number: 0xFFFA the ID of this attribute

NAME: str: “EventList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the EventList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: EventList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EventList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ContentLauncher.AttributeList

ID: number: 0xFFFB the ID of this attribute

NAME: str: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Client Commands

class st.matter.clusters.ContentLauncher.LauncherResponse

ID: number: 0x0002 the ID of this command

NAME: str: “LauncherResponse” the name of this command

status: st.matter.generated.zap_clusters.ContentLauncher.types.StatusEnum

data: st.matter.data_types.UTF8String1

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, status, data)

Builds an LauncherResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (st.matter.generated.zap_clusters.ContentLauncher.types.StatusEnum) –
data (st.matter.data_types.UTF8String1) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the LauncherResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Server Commands

class st.matter.clusters.ContentLauncher.LaunchContent

ID: number: 0x0000 the ID of this command

NAME: str: “LaunchContent” the name of this command

search: st.matter.generated.zap_clusters.ContentLauncher.types.ContentSearchStruct

auto_play: st.matter.data_types.Boolean

data: st.matter.data_types.UTF8String1

playback_preferences: st.matter.generated.zap_clusters.ContentLauncher.types.PlaybackPreferencesStruct

use_current_context: st.matter.data_types.Boolean

init(self, device, search, auto_play, data, playback_preferences, use_current_context)

Refer to LauncherResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the LaunchContent command

Parameters

self (LaunchContent) – the template class for this command
device (st.matter.Device) – the device to build this message to
search (st.matter.generated.zap_clusters.ContentLauncher.types.ContentSearchStruct) –
auto_play (st.matter.data_types.Boolean) –
data (st.matter.data_types.UTF8String1) –
playback_preferences (st.matter.generated.zap_clusters.ContentLauncher.types.PlaybackPreferencesStruct) –
use_current_context (st.matter.data_types.Boolean) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.ContentLauncher.LaunchURL

ID: number: 0x0001 the ID of this command

NAME: str: “LaunchURL” the name of this command

contenturl: st.matter.data_types.UTF8String1

display_string: st.matter.data_types.UTF8String1

branding_information: st.matter.generated.zap_clusters.ContentLauncher.types.BrandingInformationStruct

init(self, device, contenturl, display_string, branding_information)

Refer to LauncherResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the LaunchURL command

Parameters

self (LaunchURL) – the template class for this command
device (st.matter.Device) – the device to build this message to
contenturl (st.matter.data_types.UTF8String1) –
display_string (st.matter.data_types.UTF8String1) –
branding_information (st.matter.generated.zap_clusters.ContentLauncher.types.BrandingInformationStruct) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Bitmap types

class st.matter.clusters.ContentLauncher.types.Feature

CONTENT_SEARCH: number: 1

URL_PLAYBACK: number: 2

ADVANCED_SEEK: number: 3

TEXT_TRACKS: number: 4

AUDIO_TRACKS: number: 5

is_content_search_set()

Returns: True if the value of CONTENT_SEARCH is non-zero
Return type: boolean

set_content_search(): Set the value of the bit in the CONTENT_SEARCH field to 1

unset_content_search(): Set the value of the bits in the CONTENT_SEARCH field to 0

is_url_playback_set()

Returns: True if the value of URL_PLAYBACK is non-zero
Return type: boolean

set_url_playback(): Set the value of the bit in the URL_PLAYBACK field to 1

unset_url_playback(): Set the value of the bits in the URL_PLAYBACK field to 0

is_advanced_seek_set()

Returns: True if the value of ADVANCED_SEEK is non-zero
Return type: boolean

set_advanced_seek(): Set the value of the bit in the ADVANCED_SEEK field to 1

unset_advanced_seek(): Set the value of the bits in the ADVANCED_SEEK field to 0

is_text_tracks_set()

Returns: True if the value of TEXT_TRACKS is non-zero
Return type: boolean

set_text_tracks(): Set the value of the bit in the TEXT_TRACKS field to 1

unset_text_tracks(): Set the value of the bits in the TEXT_TRACKS field to 0

is_audio_tracks_set()

Returns: True if the value of AUDIO_TRACKS is non-zero
Return type: boolean

set_audio_tracks(): Set the value of the bit in the AUDIO_TRACKS field to 1

unset_audio_tracks(): Set the value of the bits in the AUDIO_TRACKS field to 0

class st.matter.clusters.ContentLauncher.types.SupportedProtocolsBitmap

DASH: number: 1

HLS: number: 2

is_dash_set()

Returns: True if the value of DASH is non-zero
Return type: boolean

set_dash(): Set the value of the bit in the DASH field to 1

unset_dash(): Set the value of the bits in the DASH field to 0

is_hls_set()

Returns: True if the value of HLS is non-zero
Return type: boolean

set_hls(): Set the value of the bit in the HLS field to 1

unset_hls(): Set the value of the bits in the HLS field to 0

Enum types

class st.matter.clusters.ContentLauncher.types.CharacteristicEnum: st.matter.data_types.Uint8 

byte_length: number: 1

FORCED_SUBTITLES: number: 0

DESCRIBES_VIDEO: number: 1

EASY_TO_READ: number: 2

FRAME_BASED: number: 3

MAIN_PROGRAM: number: 4

ORIGINAL_CONTENT: number: 5

VOICE_OVER_TRANSLATION: number: 6

CAPTION: number: 7

SUBTITLE: number: 8

ALTERNATE: number: 9

SUPPLEMENTARY: number: 10

COMMENTARY: number: 11

DUBBED_TRANSLATION: number: 12

DESCRIPTION: number: 13

METADATA: number: 14

ENHANCED_AUDIO_INTELLIGIBILITY: number: 15

EMERGENCY: number: 16

KARAOKE: number: 17

class st.matter.clusters.ContentLauncher.types.MetricTypeEnum: st.matter.data_types.Uint8 

byte_length: number: 1

PIXELS: number: 0

PERCENTAGE: number: 1

class st.matter.clusters.ContentLauncher.types.ParameterEnum: st.matter.data_types.Uint8 

byte_length: number: 1

ACTOR: number: 0

CHANNEL: number: 1

CHARACTER: number: 2

DIRECTOR: number: 3

EVENT: number: 4

FRANCHISE: number: 5

GENRE: number: 6

LEAGUE: number: 7

POPULARITY: number: 8

PROVIDER: number: 9

SPORT: number: 10

SPORTS_TEAM: number: 11

TYPE: number: 12

VIDEO: number: 13

SEASON: number: 14

EPISODE: number: 15

ANY: number: 16

class st.matter.clusters.ContentLauncher.types.StatusEnum: st.matter.data_types.Uint8 

byte_length: number: 1

SUCCESS: number: 0

URL_NOT_AVAILABLE: number: 1

AUTH_FAILED: number: 2

TEXT_TRACK_NOT_AVAILABLE: number: 3

AUDIO_TRACK_NOT_AVAILABLE: number: 4

Struct types

class st.matter.clusters.ContentLauncher.types.DimensionStruct: st.matter.data_types.Structure 

width: st.matter.data_types.DoublePrecisionFloat

height: st.matter.data_types.DoublePrecisionFloat

metric: st.matter.generated.zap_clusters.ContentLauncher.types.MetricTypeEnum

class st.matter.clusters.ContentLauncher.types.TrackPreferenceStruct: st.matter.data_types.Structure 

language_code: st.matter.data_types.UTF8String1

characteristics: st.matter.data_types.Array

audio_output_index: st.matter.data_types.Uint8

class st.matter.clusters.ContentLauncher.types.PlaybackPreferencesStruct: st.matter.data_types.Structure 

playback_position: st.matter.data_types.Uint64

text_track: st.matter.generated.zap_clusters.ContentLauncher.types.TrackPreferenceStruct

audio_tracks: st.matter.data_types.Array

class st.matter.clusters.ContentLauncher.types.AdditionalInfoStruct: st.matter.data_types.Structure 

name: st.matter.data_types.UTF8String1

value: st.matter.data_types.UTF8String1

class st.matter.clusters.ContentLauncher.types.ParameterStruct: st.matter.data_types.Structure 

type: st.matter.generated.zap_clusters.ContentLauncher.types.ParameterEnum

value: st.matter.data_types.UTF8String1

external_id_list: st.matter.data_types.Array

class st.matter.clusters.ContentLauncher.types.ContentSearchStruct: st.matter.data_types.Structure 

parameter_list: st.matter.data_types.Array

class st.matter.clusters.ContentLauncher.types.StyleInformationStruct: st.matter.data_types.Structure 

image_url: st.matter.data_types.UTF8String1

color: st.matter.data_types.UTF8String1

size: st.matter.generated.zap_clusters.ContentLauncher.types.DimensionStruct

class st.matter.clusters.ContentLauncher.types.BrandingInformationStruct: st.matter.data_types.Structure 

provider_name: st.matter.data_types.UTF8String1

background: st.matter.generated.zap_clusters.ContentLauncher.types.StyleInformationStruct

logo: st.matter.generated.zap_clusters.ContentLauncher.types.StyleInformationStruct

progress_bar: st.matter.generated.zap_clusters.ContentLauncher.types.StyleInformationStruct

splash: st.matter.generated.zap_clusters.ContentLauncher.types.StyleInformationStruct

water_mark: st.matter.generated.zap_clusters.ContentLauncher.types.StyleInformationStruct