MediaPlayback

Attributes

class st.matter.clusters.MediaPlayback.CurrentState
ID: number

0x0000 the ID of this attribute

NAME: str

“CurrentState” the name of this attribute

data_type: st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackStateEnum

the data type of this attribute

new_value(...)

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

This is also usable with the CurrentState(…) syntax

Parameters

vararg (vararg) – the values needed to construct a PlaybackStateEnum

Return type

st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackStateEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentState => 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 CurrentState 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.MediaPlayback.StartTime
ID: number

0x0001 the ID of this attribute

NAME: str

“StartTime” the name of this attribute

data_type: st.matter.data_types.Uint64

the data type of this attribute

new_value(...)

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

This is also usable with the StartTime(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Uint64

Return type

st.matter.data_types.Uint64

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: StartTime => 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 StartTime 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.MediaPlayback.Duration
ID: number

0x0002 the ID of this attribute

NAME: str

“Duration” the name of this attribute

data_type: st.matter.data_types.Uint64

the data type of this attribute

new_value(...)

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

This is also usable with the Duration(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Uint64

Return type

st.matter.data_types.Uint64

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: Duration => 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 Duration 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.MediaPlayback.SampledPosition
ID: number

0x0003 the ID of this attribute

NAME: str

“SampledPosition” the name of this attribute

data_type: st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackPositionStruct

the data type of this attribute

new_value(...)

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

This is also usable with the SampledPosition(…) syntax

Parameters

vararg (vararg) – the values needed to construct a PlaybackPositionStruct

Return type

st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackPositionStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SampledPosition => 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 SampledPosition 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.MediaPlayback.PlaybackSpeed
ID: number

0x0004 the ID of this attribute

NAME: str

“PlaybackSpeed” the name of this attribute

data_type: st.matter.data_types.SinglePrecisionFloat

the data type of this attribute

new_value(...)

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

This is also usable with the PlaybackSpeed(…) syntax

Parameters

vararg (vararg) – the values needed to construct a SinglePrecisionFloat

Return type

st.matter.data_types.SinglePrecisionFloat

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: PlaybackSpeed => 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 PlaybackSpeed 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.MediaPlayback.SeekRangeEnd
ID: number

0x0005 the ID of this attribute

NAME: str

“SeekRangeEnd” the name of this attribute

data_type: st.matter.data_types.Uint64

the data type of this attribute

new_value(...)

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

This is also usable with the SeekRangeEnd(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Uint64

Return type

st.matter.data_types.Uint64

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SeekRangeEnd => 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 SeekRangeEnd 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.MediaPlayback.SeekRangeStart
ID: number

0x0006 the ID of this attribute

NAME: str

“SeekRangeStart” the name of this attribute

data_type: st.matter.data_types.Uint64

the data type of this attribute

new_value(...)

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

This is also usable with the SeekRangeStart(…) syntax

Parameters

vararg (vararg) – the values needed to construct a Uint64

Return type

st.matter.data_types.Uint64

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SeekRangeStart => 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 SeekRangeStart 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.MediaPlayback.ActiveAudioTrack
ID: number

0x0007 the ID of this attribute

NAME: str

“ActiveAudioTrack” the name of this attribute

data_type: st.matter.generated.zap_clusters.MediaPlayback.types.TrackStruct

the data type of this attribute

new_value(...)

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

This is also usable with the ActiveAudioTrack(…) syntax

Parameters

vararg (vararg) – the values needed to construct a TrackStruct

Return type

st.matter.generated.zap_clusters.MediaPlayback.types.TrackStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: ActiveAudioTrack => 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 ActiveAudioTrack 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.MediaPlayback.AvailableAudioTracks
ID: number

0x0008 the ID of this attribute

NAME: str

“AvailableAudioTracks” 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 AvailableAudioTracks(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AvailableAudioTracks => 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 AvailableAudioTracks 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.MediaPlayback.ActiveTextTrack
ID: number

0x0009 the ID of this attribute

NAME: str

“ActiveTextTrack” the name of this attribute

data_type: st.matter.generated.zap_clusters.MediaPlayback.types.TrackStruct

the data type of this attribute

new_value(...)

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

This is also usable with the ActiveTextTrack(…) syntax

Parameters

vararg (vararg) – the values needed to construct a TrackStruct

Return type

st.matter.generated.zap_clusters.MediaPlayback.types.TrackStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: ActiveTextTrack => 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 ActiveTextTrack 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.MediaPlayback.AvailableTextTracks
ID: number

0x000A the ID of this attribute

NAME: str

“AvailableTextTracks” 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 AvailableTextTracks(…) 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
Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AvailableTextTracks => 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 AvailableTextTracks 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.MediaPlayback.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
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.MediaPlayback.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
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.MediaPlayback.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
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.MediaPlayback.PlaybackResponse
ID: number

0x000A the ID of this command

NAME: str

“PlaybackResponse” the name of this command

status: st.matter.generated.zap_clusters.MediaPlayback.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 PlaybackResponse test command reponse for the driver integration testing framework

Parameters
Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the PlaybackResponse command

Return type

nil

set_parent_cluster(cluster)
Parameters

cluster (any) –

deserialize(tlv_buf)
Parameters

tlv_buf (any) –

Server Commands

class st.matter.clusters.MediaPlayback.Play
ID: number

0x0000 the ID of this command

NAME: str

“Play” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Play) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.Pause
ID: number

0x0001 the ID of this command

NAME: str

“Pause” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Pause) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.Stop
ID: number

0x0002 the ID of this command

NAME: str

“Stop” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Stop) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.StartOver
ID: number

0x0003 the ID of this command

NAME: str

“StartOver” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (StartOver) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.Previous
ID: number

0x0004 the ID of this command

NAME: str

“Previous” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Previous) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.Next
ID: number

0x0005 the ID of this command

NAME: str

“Next” the name of this command

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Next) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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.MediaPlayback.Rewind
ID: number

0x0006 the ID of this command

NAME: str

“Rewind” the name of this command

audio_advance_unmuted: st.matter.data_types.Boolean
init(self, device, audio_advance_unmuted)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters
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.MediaPlayback.FastForward
ID: number

0x0007 the ID of this command

NAME: str

“FastForward” the name of this command

audio_advance_unmuted: st.matter.data_types.Boolean
init(self, device, audio_advance_unmuted)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters
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.MediaPlayback.SkipForward
ID: number

0x0008 the ID of this command

NAME: str

“SkipForward” the name of this command

delta_position_milliseconds: st.matter.data_types.Uint64
init(self, device, delta_position_milliseconds)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters
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.MediaPlayback.SkipBackward
ID: number

0x0009 the ID of this command

NAME: str

“SkipBackward” the name of this command

delta_position_milliseconds: st.matter.data_types.Uint64
init(self, device, delta_position_milliseconds)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters
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.MediaPlayback.Seek
ID: number

0x000B the ID of this command

NAME: str

“Seek” the name of this command

position: st.matter.data_types.Uint64
init(self, device, position)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters
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.MediaPlayback.ActivateAudioTrack
ID: number

0x000C the ID of this command

NAME: str

“ActivateAudioTrack” the name of this command

trackid: st.matter.data_types.UTF8String1
audio_output_index: st.matter.data_types.Uint8
build_test_command_response(device, endpoint_id, status)

Builds an ActivateAudioTrack 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 (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, trackid, audio_output_index)

Initialize the ActivateAudioTrack command

Parameters
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.MediaPlayback.ActivateTextTrack
ID: number

0x000D the ID of this command

NAME: str

“ActivateTextTrack” the name of this command

trackid: st.matter.data_types.UTF8String1
build_test_command_response(device, endpoint_id, status)

Builds an ActivateTextTrack 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 (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device, trackid)

Initialize the ActivateTextTrack command

Parameters
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.MediaPlayback.DeactivateTextTrack
ID: number

0x000E the ID of this command

NAME: str

“DeactivateTextTrack” the name of this command

build_test_command_response(device, endpoint_id, status)

Builds an DeactivateTextTrack 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 (str) – Interaction status associated with the path

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init(self, device)

Initialize the DeactivateTextTrack command

Parameters

  • self (DeactivateTextTrack) – the template class for this command

  • device (st.matter.Device) – the device to build this message to

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) –

Events

class st.matter.clusters.MediaPlayback.StateChanged
ID: number

0x0000 the ID of this event

NAME: str

“StateChanged” the name of this event

current_state: st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackStateEnum
start_time: st.matter.data_types.Uint64
duration: st.matter.data_types.Uint64
sampled_position: st.matter.generated.zap_clusters.MediaPlayback.types.PlaybackPositionStruct
playback_speed: st.matter.data_types.SinglePrecisionFloat
seek_range_end: st.matter.data_types.Uint64
seek_range_start: st.matter.data_types.Uint64
data: st.matter.data_types.OctetString1
audio_advance_unmuted: st.matter.data_types.Boolean
augment_type(base_type_obj)

Add field names to each event field

Parameters

base_type_obj (st.matter.data_types.Structure) –

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters
Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters

  • device (any) –

  • endpoint_id (number or nil) –

Return type

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)

Builds an StateChanged test event report reponse to be used by

the driver integration testing framework.

Parameters

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil) –

  • fields (table) – containing the event fields

  • 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) –

set_parent_cluster(cluster)
Parameters

cluster (any) –

Bitmap types

class st.matter.clusters.MediaPlayback.types.Feature
ADVANCED_SEEK: number

1

VARIABLE_SPEED: number

2

TEXT_TRACKS: number

4

AUDIO_TRACKS: number

8

AUDIO_ADVANCE: number

16

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_variable_speed_set()
Returns

True if the value of VARIABLE_SPEED is non-zero

Return type

boolean

set_variable_speed()

Set the value of the bit in the VARIABLE_SPEED field to 1

unset_variable_speed()

Set the value of the bits in the VARIABLE_SPEED 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

is_audio_advance_set()
Returns

True if the value of AUDIO_ADVANCE is non-zero

Return type

boolean

set_audio_advance()

Set the value of the bit in the AUDIO_ADVANCE field to 1

unset_audio_advance()

Set the value of the bits in the AUDIO_ADVANCE field to 0

Enum types

class st.matter.clusters.MediaPlayback.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.MediaPlayback.types.PlaybackStateEnum: st.matter.data_types.Uint8
byte_length: number

1

PLAYING: number

0

PAUSED: number

1

NOT_PLAYING: number

2

BUFFERING: number

3

class st.matter.clusters.MediaPlayback.types.StatusEnum: st.matter.data_types.Uint8
byte_length: number

1

SUCCESS: number

0

INVALID_STATE_FOR_COMMAND: number

1

NOT_ALLOWED: number

2

NOT_ACTIVE: number

3

SPEED_OUT_OF_RANGE: number

4

SEEK_OUT_OF_RANGE: number

5

Struct types

class st.matter.clusters.MediaPlayback.types.TrackAttributesStruct: st.matter.data_types.Structure
language_code: st.matter.data_types.UTF8String1
display_name: st.matter.data_types.UTF8String1
class st.matter.clusters.MediaPlayback.types.TrackStruct: st.matter.data_types.Structure
id: st.matter.data_types.UTF8String1
track_attributes: st.matter.generated.zap_clusters.MediaPlayback.types.TrackAttributesStruct
class st.matter.clusters.MediaPlayback.types.PlaybackPositionStruct: st.matter.data_types.Structure
updated_at: st.matter.data_types.Uint64
position: st.matter.data_types.Uint64