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.data_types.Uint8

the data type of this attribute

PLAYING: number

0

PAUSED: number

1

NOT_PLAYING: number

2

BUFFERING: number

3

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

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

new_value(...)

Create a Uint8 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 Uint8

Return type

st.matter.data_types.Uint8

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.data_types.Structure

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.Structure) – the base data type object to add functionality to

new_value(...)

Create a Structure 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 Structure

Return type

st.matter.data_types.Structure

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.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

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.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

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.clusters.MediaPlayback.types.MediaPlaybackStatusEnum
data: 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.StopPlayback
ID: number

0x0002 the ID of this command

NAME: str

“StopPlayback” 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 StopPlayback command

Parameters

  • self (StopPlayback) – 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

init(self, device)

Refer to PlaybackResponse:build_test_command_response for

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

Parameters

  • self (Rewind) – 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.FastForward
ID: number

0x0007 the ID of this command

NAME: str

“FastForward” 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 FastForward command

Parameters

  • self (FastForward) – 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.SkipForward
ID: number

0x0008 the ID of this command

NAME: str

“SkipForward” the name of this command

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

Bitmap types

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

1

VARIABLE_SPEED: number

2

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

Enum types

class st.matter.clusters.MediaPlayback.types.MediaPlaybackStatusEnum: 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

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

Struct types

class st.matter.clusters.MediaPlayback.types.PlaybackPosition: st.matter.data_types.Structure
updated_at: st.matter.data_types.Uint64
position: st.matter.data_types.Uint64