ask_sdk_model.interfaces.audioplayer package¶

Submodules¶

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.interfaces.audioplayer.audio_item module¶

class ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem(stream=None, metadata=None)¶

Bases: object

Parameters:	stream ((optional) ask_sdk_model.interfaces.audioplayer.stream.Stream) – metadata ((optional) ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata) –

attribute_map = {'metadata': 'metadata', 'stream': 'stream'}¶

deserialized_types = {'metadata': 'ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata', 'stream': 'ask_sdk_model.interfaces.audioplayer.stream.Stream'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_item_metadata module¶

class ask_sdk_model.interfaces.audioplayer.audio_item_metadata.AudioItemMetadata(title=None, subtitle=None, art=None, background_image=None)¶

Bases: object

Encapsulates the metadata about an AudioItem.

Parameters:

title ((optional) str) – An optional title of the audio item.
subtitle ((optional) str) – An optional subtitle of the audio item.
art ((optional) ask_sdk_model.interfaces.display.image.Image) – An optional cover art image for the audio item.
background_image ((optional) ask_sdk_model.interfaces.display.image.Image) – An optional background image for the audio item.

attribute_map = {'art': 'art', 'background_image': 'backgroundImage', 'subtitle': 'subtitle', 'title': 'title'}¶

deserialized_types = {'art': 'ask_sdk_model.interfaces.display.image.Image', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'subtitle': 'str', 'title': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_player_interface module¶

class ask_sdk_model.interfaces.audioplayer.audio_player_interface.AudioPlayerInterface¶

Bases: object

attribute_map = {}¶

deserialized_types = {}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.audio_player_state module¶

class ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState(offset_in_milliseconds=None, token=None, player_activity=None)¶

Bases: object

Parameters:	offset_in_milliseconds ((optional) int) – token ((optional) str) – player_activity ((optional) ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity) –

attribute_map = {'offset_in_milliseconds': 'offsetInMilliseconds', 'player_activity': 'playerActivity', 'token': 'token'}¶

deserialized_types = {'offset_in_milliseconds': 'int', 'player_activity': 'ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.caption_data module¶

class ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData(content=None, object_type=None)¶

Bases: object

Parameters:	content ((optional) str) – This contains the caption text. object_type ((optional) ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType) – Type of the caption source.

attribute_map = {'content': 'content', 'object_type': 'type'}¶

deserialized_types = {'content': 'str', 'object_type': 'ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.caption_type module¶

class ask_sdk_model.interfaces.audioplayer.caption_type.CaptionType¶

Bases: enum.Enum

Allowed enum values: [WEBVTT]

WEBVTT = 'WEBVTT'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.clear_behavior module¶

class ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior¶

Bases: enum.Enum

Allowed enum values: [CLEAR_ALL, CLEAR_ENQUEUED]

CLEAR_ALL = 'CLEAR_ALL'¶

CLEAR_ENQUEUED = 'CLEAR_ENQUEUED'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.clear_queue_directive module¶

class ask_sdk_model.interfaces.audioplayer.clear_queue_directive.ClearQueueDirective(clear_behavior=None)¶

Bases: ask_sdk_model.directive.Directive

Parameters:	clear_behavior ((optional) ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior) –

attribute_map = {'clear_behavior': 'clearBehavior', 'object_type': 'type'}¶

deserialized_types = {'clear_behavior': 'ask_sdk_model.interfaces.audioplayer.clear_behavior.ClearBehavior', 'object_type': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.current_playback_state module¶

class ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState(offset_in_milliseconds=None, player_activity=None, token=None)¶

Bases: object

Parameters:	offset_in_milliseconds ((optional) int) – player_activity ((optional) ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity) – token ((optional) str) –

attribute_map = {'offset_in_milliseconds': 'offsetInMilliseconds', 'player_activity': 'playerActivity', 'token': 'token'}¶

deserialized_types = {'offset_in_milliseconds': 'int', 'player_activity': 'ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.error module¶

class ask_sdk_model.interfaces.audioplayer.error.Error(message=None, object_type=None)¶

Bases: object

Parameters:	message ((optional) str) – object_type ((optional) ask_sdk_model.interfaces.audioplayer.error_type.ErrorType) –

attribute_map = {'message': 'message', 'object_type': 'type'}¶

deserialized_types = {'message': 'str', 'object_type': 'ask_sdk_model.interfaces.audioplayer.error_type.ErrorType'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.error_type module¶

class ask_sdk_model.interfaces.audioplayer.error_type.ErrorType¶

Bases: enum.Enum

Allowed enum values: [MEDIA_ERROR_INTERNAL_DEVICE_ERROR, MEDIA_ERROR_INTERNAL_SERVER_ERROR, MEDIA_ERROR_INVALID_REQUEST, MEDIA_ERROR_SERVICE_UNAVAILABLE, MEDIA_ERROR_UNKNOWN]

MEDIA_ERROR_INTERNAL_DEVICE_ERROR = 'MEDIA_ERROR_INTERNAL_DEVICE_ERROR'¶

MEDIA_ERROR_INTERNAL_SERVER_ERROR = 'MEDIA_ERROR_INTERNAL_SERVER_ERROR'¶

MEDIA_ERROR_INVALID_REQUEST = 'MEDIA_ERROR_INVALID_REQUEST'¶

MEDIA_ERROR_SERVICE_UNAVAILABLE = 'MEDIA_ERROR_SERVICE_UNAVAILABLE'¶

MEDIA_ERROR_UNKNOWN = 'MEDIA_ERROR_UNKNOWN'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.play_behavior module¶

class ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior¶

Bases: enum.Enum

Allowed enum values: [ENQUEUE, REPLACE_ALL, REPLACE_ENQUEUED]

ENQUEUE = 'ENQUEUE'¶

REPLACE_ALL = 'REPLACE_ALL'¶

REPLACE_ENQUEUED = 'REPLACE_ENQUEUED'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.play_directive module¶

class ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective(play_behavior=None, audio_item=None)¶

Bases: ask_sdk_model.directive.Directive

Parameters:	play_behavior ((optional) ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior) – audio_item ((optional) ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem) –

attribute_map = {'audio_item': 'audioItem', 'object_type': 'type', 'play_behavior': 'playBehavior'}¶

deserialized_types = {'audio_item': 'ask_sdk_model.interfaces.audioplayer.audio_item.AudioItem', 'object_type': 'str', 'play_behavior': 'ask_sdk_model.interfaces.audioplayer.play_behavior.PlayBehavior'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_failed_request module¶

class ask_sdk_model.interfaces.audioplayer.playback_failed_request.PlaybackFailedRequest(request_id=None, timestamp=None, locale=None, current_playback_state=None, error=None, token=None)¶

Bases: ask_sdk_model.request.Request

Parameters:

request_id ((optional) str) – Represents the unique identifier for the specific request.
timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
current_playback_state ((optional) ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState) –
error ((optional) ask_sdk_model.interfaces.audioplayer.error.Error) –
token ((optional) str) –

attribute_map = {'current_playback_state': 'currentPlaybackState', 'error': 'error', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}¶

deserialized_types = {'current_playback_state': 'ask_sdk_model.interfaces.audioplayer.current_playback_state.CurrentPlaybackState', 'error': 'ask_sdk_model.interfaces.audioplayer.error.Error', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_finished_request module¶

class ask_sdk_model.interfaces.audioplayer.playback_finished_request.PlaybackFinishedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)¶

Bases: ask_sdk_model.request.Request

Parameters:

request_id ((optional) str) – Represents the unique identifier for the specific request.
timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
offset_in_milliseconds ((optional) int) –
token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}¶

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request module¶

class ask_sdk_model.interfaces.audioplayer.playback_nearly_finished_request.PlaybackNearlyFinishedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)¶

Bases: ask_sdk_model.request.Request

Parameters:

request_id ((optional) str) – Represents the unique identifier for the specific request.
timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
offset_in_milliseconds ((optional) int) –
token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}¶

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_started_request module¶

class ask_sdk_model.interfaces.audioplayer.playback_started_request.PlaybackStartedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)¶

Bases: ask_sdk_model.request.Request

Parameters:

request_id ((optional) str) – Represents the unique identifier for the specific request.
timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
offset_in_milliseconds ((optional) int) –
token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}¶

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.playback_stopped_request module¶

class ask_sdk_model.interfaces.audioplayer.playback_stopped_request.PlaybackStoppedRequest(request_id=None, timestamp=None, locale=None, offset_in_milliseconds=None, token=None)¶

Bases: ask_sdk_model.request.Request

Parameters:

request_id ((optional) str) – Represents the unique identifier for the specific request.
timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
offset_in_milliseconds ((optional) int) –
token ((optional) str) –

attribute_map = {'locale': 'locale', 'object_type': 'type', 'offset_in_milliseconds': 'offsetInMilliseconds', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}¶

deserialized_types = {'locale': 'str', 'object_type': 'str', 'offset_in_milliseconds': 'int', 'request_id': 'str', 'timestamp': 'datetime', 'token': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.player_activity module¶

class ask_sdk_model.interfaces.audioplayer.player_activity.PlayerActivity¶

Bases: enum.Enum

Allowed enum values: [PLAYING, PAUSED, FINISHED, BUFFER_UNDERRUN, IDLE, STOPPED]

BUFFER_UNDERRUN = 'BUFFER_UNDERRUN'¶

FINISHED = 'FINISHED'¶

IDLE = 'IDLE'¶

PAUSED = 'PAUSED'¶

PLAYING = 'PLAYING'¶

STOPPED = 'STOPPED'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.stop_directive module¶

class ask_sdk_model.interfaces.audioplayer.stop_directive.StopDirective¶

Bases: ask_sdk_model.directive.Directive

attribute_map = {'object_type': 'type'}¶

deserialized_types = {'object_type': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.audioplayer.stream module¶

class ask_sdk_model.interfaces.audioplayer.stream.Stream(expected_previous_token=None, token=None, url=None, offset_in_milliseconds=None, caption_data=None)¶

Bases: object

Parameters:	expected_previous_token ((optional) str) – token ((optional) str) – url ((optional) str) – offset_in_milliseconds ((optional) int) – caption_data ((optional) ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData) –

attribute_map = {'caption_data': 'captionData', 'expected_previous_token': 'expectedPreviousToken', 'offset_in_milliseconds': 'offsetInMilliseconds', 'token': 'token', 'url': 'url'}¶

deserialized_types = {'caption_data': 'ask_sdk_model.interfaces.audioplayer.caption_data.CaptionData', 'expected_previous_token': 'str', 'offset_in_milliseconds': 'int', 'token': 'str', 'url': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model