Skip to main content

Module types

Module types 

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that AWS Elemental Inference can respond with.

Structs§

AspectRatio

The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout.

ClippingConfig

A type of OutputConfig, used when the output in a feed is for the clip feature.

Competitor

Contains information about one competitor in a fixture. It is used in the FixtureSummary that is in the SearchFixtures response.

CreateOutput

Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.

CroppingConfig

A type of OutputConfig, used when the output in a feed is for the crop feature.

DataSourceConfiguration

Contains the data source configuration for a clipping output. It identifies the fixture whose event data Elemental Inference maps onto the clipping metadata. It is used in the dataSourceConfiguration property of a ClippingConfig.

DictionarySummary

Contains summary information about a dictionary. Used in the ListDictionaries response.

FeedAssociation

Contains information about the resource that is associated with a feed. It is used in the FeedSummary that is used in the response of a ListFeeds action.

FeedSummary

Contains configuration information about a feed. It is used in the ListFeeds response.

FixtureSummary

Contains information about one fixture. It is used in the SearchFixtures response.

Elemental Inference relays the information in this structure from the data source, so that you can identify the fixture that matches your source media.

GetOutput

Contains configuration information about one output in a feed. It is used in the GetFeed response.

SearchFilter

A filter for a fixture search. It is used in the filters array of a SearchFixtures request.

SubtitlingConfig

A type of OutputConfig, used when the output in a feed is for the smart subtitling feature. smart subtitling uses automatic speech recognition (ASR) to generate live TTML subtitles from the audio in your source media.

TemplateGroup

A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.

UpdateOutput

Contains configuration information about one output in a feed. It is used in the UpdateFeed action.

Enums§

DataSourceSport
When writing a match expression against DataSourceSport, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DictionaryLanguage
When writing a match expression against DictionaryLanguage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DictionaryStatus
When writing a match expression against DictionaryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeedStatus
When writing a match expression against FeedStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FilterName
When writing a match expression against FilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OutputConfig

Contains one typed output. It is used in the CreateOutput, GetOutput, and Update Output structures.

OutputStatus
When writing a match expression against OutputStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProfanityFilterMode
When writing a match expression against ProfanityFilterMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TranscriptionLanguage
When writing a match expression against TranscriptionLanguage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.