MediaPlaybackRequestor

Outgoing Messages

MediaPlaybackResponse

Result of the RequestMediaPlayback request.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "MediaPlaybackRequestor",
            "action": "MediaPlaybackResponse"
        }
    },
    "payload": {
        "mediaPlaybackRequestStatus": {{MediaPlaybackRequestStatus}}        
    }
}

Payload

Property	Type	Required	Description	Example
mediaPlaybackRequestStatus	MediaPlaybackRequestStatus	Yes	Enum value representing the response of the RequestMediaPlaybackMessage request.

Incoming Messages

RequestMediaPlayback

OEM Developers are expected to call this method whenever Alexa is the right candidate for the media resume.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "MediaPlaybackRequestor",
            "action": "RequestMediaPlayback"
        }
    },
    "payload": {
        "invocationReason": {{InvocationReason}},
        "elapsedBootTime": {{int64}}        
    }
}

Payload

Property	Type	Required	Description	Example
invocationReason	InvocationReason	Yes	Reason for calling this API.
elapsedBootTime	int64	Yes	Provide the elapsed boot time in mili seconds if your platform does not provide a right value using https://developer.android.com/reference/android/os/SystemClock#elapsedRealtime() or https://man7.org/linux/man-pages/man2/sysinfo.2.html uptime.

Enums

MediaPlaybackRequestStatus

Values

Value	Description
"SUCCESS"	Successful description.
"FAILED_CAN_RETRY"	Failure description.
"FAILED_TIMEOUT"	Too late to send RequestMediaPlaybackMessage, Failed to deliver.
"ERROR"	Event call is failed because of an error.

InvocationReason

Values

Value	Description
"AUTOMOTIVE_STARTUP"	System call for the automatic media resume.
"EXPLICIT_USER_ACTION"	Driver action for the media resume.