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

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:
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]

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

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]

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

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

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)

Bases: object

Parameters:
  • expected_previous_token ((optional) str) –
  • token ((optional) str) –
  • url ((optional) str) –
  • offset_in_milliseconds ((optional) int) –
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model