Data object Capabilities
interface struct Capabilities
Describes the capabilities of a media session.
Fields
actions
This property lists all the actions that the media session can perform. when receiving requests through [IMediaControlHandlerAsync]. Actions could include playback controls (e.g., play, pause, stop), navigation commands (e.g., skip forward, rewind), and other media-related operations (e.g., set rating, get metadata). By defining a list of supported actions a consumer can adapt their functionality based on the available actions.Action[]— Required
speeds
float[] — Required
The list of supported playback speeds.
- These values allow clients to adjust the speed of media playback, with 1.0 representing normal speed.
- Values greater than 1.0 accelerate playback, whereas values between 0 and 1.0 slow it down.
-
For example: The following array
[0.25 0.5 0.75, 1.0 1.5 2.0]says the media control servers supports playing back at a 1/4, 1/2, 3/4, normal, 1-1/2 and 2x only, but nothing in between. - When this array is empty, it means the range of supported speeds is continous from 0.0 exclusive to an unspecified max speed.
- When this array contains values, it means only the specific values contained in the array are supported when handling the request [IMediaControlHandlerAsync#handleSetPlaybackSpeed].
ratings
float[] — Required
The list of supported ratings that can be used to rate media.
See [IMediaControlHandlerAsync#handleSetRating].
- This is useful to map to rating systems like “5 stars” or thumbs up/down.
-
For example a thumbs up/down system would set the array to
[0.0, 1.0]. -
A five-star system would set the array to
[0.0 0.25 0.5 0.75 1.0]. - Each rating is a normalized value from 0.0 to 1.0, where 0.0 indicates the worst rating and 1.0 the best rating.
- The array of ratings can be empty, in which case the media playback application supports a continous rating range from 0.0 to 1.0.
- When the array has values, only the values indicated in the array are supported.
forwardSkipSteps
The list of supported discrete forward skip steps. See [IMediaControlHandlerAsync#handleSkipForward].com.amazon.apmf.MonotonicDuration[]— Required
-
When this array is empty - it means
handleSkipForwardcan accept any arbitrary value. - When this array contains values, it means only the specific values contained in the array are supported.
- For example, specifying an array of containing 10s and 30s means means the media session only accepts skip forward requests with 10s and 30s values.
backwardSkipSteps
The list of supported discrete backward skip steps. See [IMediaControlHandlerAsync#handleSkipBackward].com.amazon.apmf.MonotonicDuration[]— Required
-
When this array is empty - it means
handleSkipBackwardcan accept any arbitrary value. - When this array contains values, it means only the specific values contained in the array are supported.
- For example, specifying an array of containing 10s and 30s means means the media session only accepts skip backard requests with 10s and 30s values.
