Home > Alexa > Alexa Skills Kit

Alexa.PlaybackController Interface (Alexa Skills Kit)

summary

The PlaybackController interface describes messages that are used to play, stop, and navigate playback for audio or video content.

Directives

The following table shows the directive support depending on the type of skill you are implementing.

Directive Skill Type
FastForward Smart Home, Video
Next Smart Home, Video
Pause Smart Home, Video
Play Smart Home, Video
Previous Smart Home, Video
Rewind Smart Home, Video
StartOver Smart Home, Video
Stop Smart Home, Video

FastForward

Request to fast forward the current content.

“Alexa, fast forward on device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "FastForward",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {

      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Next

Request to go to the next item in content playback.

“Alexa, next song/video/photo on device

“Alexa, go forward on device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Next",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {

      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Pause

Request to pause the playback of audio or video content.

“Alexa, pause device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Pause",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Play

Request to play or resume play of audio or video content.

“Alexa, resume device

“Alexa, play device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Play",
      "messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {
      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Previous

Request to go to the previous item in content playback.

“Alexa, go back on device.

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Previous",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {

      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Rewind

Request to rewind the current content.

“Alexa, rewind on device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Rewind",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {

      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

StartOver

A request to start playback from the beginning of the audio or visual content.

“Alexa, start over on device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "StartOver",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Stop

Request to stop playback of audio or video content.

“Alexa, stop device

Example Request:

{
  "directive": {
    "header": {
      "namespace": "Alexa.PlaybackController",
      "name": "Stop",
      "messageId": "c8d53423-b49b-48ee-9181-f50acedf2870",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "device-001",
      "cookie": {

      }
    },
    "payload": {
    }
  }
}

Payload Details

Field Description Type Required
None No required or optional fields in the payload. N/A N/A

Properties and Events

Reportable Properties

The Alexa.PlaybackController interface doesn’t define any reportable properties at this time.

Alexa.Response Event

If any of the directives in this interface successfully complete, you should send a response event.

Example Alexa.Response

{
  "context": {
    "properties": []
  },
  "event": {
    "header": {
      "messageId": "30d2cd1a-ce4f-4542-aa5e-04bd0a6492d5",
      "namespace": "Alexa",
      "name": "Response",
      "payloadVersion": "3"
    },
    "payload": {
    }
  }
}
Interface Description
Alexa.RemoteVideoPlayer Provides directives for searching and playing content.