ask_sdk_model.interfaces.viewport package¶

Subpackages¶

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.viewport.apl_viewport_state module¶

class ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState(id=None, shape=None, dpi=None, presentation_type=None, can_rotate=None, configuration=None)¶

Bases: ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState

This object contains the characteristics related to the APL device's viewport.

Parameters:

id ((optional) str) – unique identifier of a viewport object
shape ((optional) ask_sdk_model.interfaces.viewport.shape.Shape) –
dpi ((optional) float) – The pixel density of the viewport.
presentation_type ((optional) ask_sdk_model.interfaces.viewport.presentation_type.PresentationType) –
can_rotate ((optional) bool) – Indicates if the viewport can be rotated through 90 degrees.
configuration ((optional) ask_sdk_model.interfaces.viewport.apl.viewport_configuration.ViewportConfiguration) –

attribute_map = {'can_rotate': 'canRotate', 'configuration': 'configuration', 'dpi': 'dpi', 'id': 'id', 'object_type': 'type', 'presentation_type': 'presentationType', 'shape': 'shape'}¶

deserialized_types = {'can_rotate': 'bool', 'configuration': 'ask_sdk_model.interfaces.viewport.apl.viewport_configuration.ViewportConfiguration', 'dpi': 'float', 'id': 'str', 'object_type': 'str', 'presentation_type': 'ask_sdk_model.interfaces.viewport.presentation_type.PresentationType', 'shape': 'ask_sdk_model.interfaces.viewport.shape.Shape'}¶

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.viewport.aplt_viewport_state module¶

class ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState(id=None, supported_profiles=None, line_length=None, line_count=None, character_format=None, inter_segments=None)¶

Bases: ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState

This object contains the characteristics related to the text device's viewport.

Parameters:

id ((optional) str) – unique identifier of a viewport object
supported_profiles ((optional) list[ask_sdk_model.interfaces.viewport.aplt.viewport_profile.ViewportProfile]) – List of profiles that device can emulate.
line_length ((optional) int) – horizontal dimension of text display in number of characters
line_count ((optional) int) – vertical dimension of text display in number of rows
character_format ((optional) ask_sdk_model.interfaces.viewport.aplt.character_format.CharacterFormat) –
inter_segments ((optional) list[ask_sdk_model.interfaces.viewport.aplt.inter_segment.InterSegment]) – list of inter-segment objects

attribute_map = {'character_format': 'characterFormat', 'id': 'id', 'inter_segments': 'interSegments', 'line_count': 'lineCount', 'line_length': 'lineLength', 'object_type': 'type', 'supported_profiles': 'supportedProfiles'}¶

deserialized_types = {'character_format': 'ask_sdk_model.interfaces.viewport.aplt.character_format.CharacterFormat', 'id': 'str', 'inter_segments': 'list[ask_sdk_model.interfaces.viewport.aplt.inter_segment.InterSegment]', 'line_count': 'int', 'line_length': 'int', 'object_type': 'str', 'supported_profiles': 'list[ask_sdk_model.interfaces.viewport.aplt.viewport_profile.ViewportProfile]'}¶

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.viewport.experience module¶

class ask_sdk_model.interfaces.viewport.experience.Experience(arc_minute_width=None, arc_minute_height=None, can_rotate=None, can_resize=None)¶

Bases: object

An experience represents a viewing mode used to interact with the device.

Parameters:

arc_minute_width ((optional) float) – The number of horizontal arc minutes the viewport occupies in the user's visual field when viewed within this experience.
arc_minute_height ((optional) float) – The number of vertical arc minutes the viewport occupies in the user's visual field when viewed within this experience.
can_rotate ((optional) bool) – Indicates if the viewport can be rotated through 90 degrees.
can_resize ((optional) bool) – Indicates if the viewport can be resized, limiting the area which can be used to render the APL response.

attribute_map = {'arc_minute_height': 'arcMinuteHeight', 'arc_minute_width': 'arcMinuteWidth', 'can_resize': 'canResize', 'can_rotate': 'canRotate'}¶

deserialized_types = {'arc_minute_height': 'float', 'arc_minute_width': 'float', 'can_resize': 'bool', 'can_rotate': 'bool'}¶

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.viewport.keyboard module¶

class ask_sdk_model.interfaces.viewport.keyboard.Keyboard¶

Bases: enum.Enum

Represents a physical button input mechanism which can be used to interact with elements shown on the viewport.

Allowed enum values: [DIRECTION]

DIRECTION = 'DIRECTION'¶

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

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

ask_sdk_model.interfaces.viewport.mode module¶

class ask_sdk_model.interfaces.viewport.mode.Mode¶

Bases: enum.Enum

The expected use case of the device's viewport, encapsulating the available input mechanisms and user viewing distance.

Allowed enum values: [AUTO, HUB, MOBILE, PC, TV]

AUTO = 'AUTO'¶

HUB = 'HUB'¶

MOBILE = 'MOBILE'¶

PC = 'PC'¶

TV = 'TV'¶

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

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

ask_sdk_model.interfaces.viewport.presentation_type module¶

class ask_sdk_model.interfaces.viewport.presentation_type.PresentationType¶

Bases: enum.Enum

Type of the viewport. * `STANDARD` Indicates that this viewport occupies an exclusive area of the screen. * `OVERLAY` Indicates that the viewport is an overlay, sharing the screen with other experiences.

Allowed enum values: [STANDARD, OVERLAY]

OVERLAY = 'OVERLAY'¶

STANDARD = 'STANDARD'¶

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

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

ask_sdk_model.interfaces.viewport.shape module¶

class ask_sdk_model.interfaces.viewport.shape.Shape¶

Bases: enum.Enum

The shape of the viewport.

Allowed enum values: [RECTANGLE, ROUND]

RECTANGLE = 'RECTANGLE'¶

ROUND = 'ROUND'¶

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

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

ask_sdk_model.interfaces.viewport.touch module¶

class ask_sdk_model.interfaces.viewport.touch.Touch¶

Bases: enum.Enum

Represents a type of touch input suppported by the device.

Allowed enum values: [SINGLE]

SINGLE = 'SINGLE'¶

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

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

ask_sdk_model.interfaces.viewport.typed_viewport_state module¶

class ask_sdk_model.interfaces.viewport.typed_viewport_state.TypedViewportState(id=None, object_type=None)¶

Bases: object

Parameters:	id ((optional) str) – unique identifier of a viewport object object_type ((optional) str) – name of the type of a viewport object

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

APL: ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState,

APLT: ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState

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

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

discriminator_value_class_map = {'APL': 'ask_sdk_model.interfaces.viewport.apl_viewport_state.APLViewportState', 'APLT': 'ask_sdk_model.interfaces.viewport.aplt_viewport_state.APLTViewportState'}¶

classmethod get_real_child_model(data)¶: Returns the real base class specified by the discriminator

json_discriminator_key = 'type'¶

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.viewport.viewport_state module¶

class ask_sdk_model.interfaces.viewport.viewport_state.ViewportState(experiences=None, mode=None, shape=None, pixel_width=None, pixel_height=None, dpi=None, current_pixel_width=None, current_pixel_height=None, touch=None, keyboard=None, video=None)¶

Bases: object

This object contains the characteristics related to the device's viewport.

Parameters:

experiences ((optional) list[ask_sdk_model.interfaces.viewport.experience.Experience]) – The experiences supported by the device, in descending order of arcMinuteWidth and arcMinuteHeight.
mode ((optional) ask_sdk_model.interfaces.viewport.mode.Mode) –
shape ((optional) ask_sdk_model.interfaces.viewport.shape.Shape) –
pixel_width ((optional) float) – The number of pixels present in the viewport at its maximum width.
pixel_height ((optional) float) – The number of pixels present in the viewport at its maximum height.
dpi ((optional) float) – The pixel density of the viewport.
current_pixel_width ((optional) float) – The number of horizontal pixels in the viewport that are currently available for Alexa to render an experience.
current_pixel_height ((optional) float) – The number of vertical pixels in the viewport that are currently available for Alexa to render an experience.
touch ((optional) list[ask_sdk_model.interfaces.viewport.touch.Touch]) – The types of touch supported by the device. An empty array indicates no touch support.
keyboard ((optional) list[ask_sdk_model.interfaces.viewport.keyboard.Keyboard]) – The physical button input mechanisms supported by the device. An empty array indicates physical button input is unsupported.
video ((optional) ask_sdk_model.interfaces.viewport.viewport_state_video.Video) –

attribute_map = {'current_pixel_height': 'currentPixelHeight', 'current_pixel_width': 'currentPixelWidth', 'dpi': 'dpi', 'experiences': 'experiences', 'keyboard': 'keyboard', 'mode': 'mode', 'pixel_height': 'pixelHeight', 'pixel_width': 'pixelWidth', 'shape': 'shape', 'touch': 'touch', 'video': 'video'}¶

deserialized_types = {'current_pixel_height': 'float', 'current_pixel_width': 'float', 'dpi': 'float', 'experiences': 'list[ask_sdk_model.interfaces.viewport.experience.Experience]', 'keyboard': 'list[ask_sdk_model.interfaces.viewport.keyboard.Keyboard]', 'mode': 'ask_sdk_model.interfaces.viewport.mode.Mode', 'pixel_height': 'float', 'pixel_width': 'float', 'shape': 'ask_sdk_model.interfaces.viewport.shape.Shape', 'touch': 'list[ask_sdk_model.interfaces.viewport.touch.Touch]', 'video': 'ask_sdk_model.interfaces.viewport.viewport_state_video.Video'}¶

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.viewport.viewport_state_video module¶

class ask_sdk_model.interfaces.viewport.viewport_state_video.Video(codecs=None)¶

Bases: object

Details of the technologies which are available for playing video on the device.

Parameters:	codecs ((optional) list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]) – Codecs which are available for playing video on the device.

attribute_map = {'codecs': 'codecs'}¶

deserialized_types = {'codecs': 'list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]'}¶

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.viewport.viewport_video module¶

class ask_sdk_model.interfaces.viewport.viewport_video.ViewportVideo(codecs=None)¶

Bases: object

Details of the technologies which are available for playing video on the device.

Parameters:	codecs ((optional) list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]) – Codecs which are available for playing video on the device.

attribute_map = {'codecs': 'codecs'}¶

deserialized_types = {'codecs': 'list[ask_sdk_model.interfaces.viewport.video.codecs.Codecs]'}¶

supports_multiple_types = False¶

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

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