A helper class that provides an aggregation of all video entity types. Users can ask Alexa to search for video content by specifying characteristics of the content, such as a season and episode of a TV show, or a genre of movie. Alexa sends these characteristics, called entity types for searching the requested content. This class also provides methods to parse the entity payload into respective types. More...

#include <VideoEntityTypes.h>

Classes
struct	Actor

struct	App

struct	Channel

struct	Character

struct	Director

struct	Episode

struct	Event

struct	Franchise

struct	Genre

struct	League

struct	Media

struct	Popularity

struct	ProductionCompany

struct	Recency

struct	Season

struct	Sport

struct	SportsTeam

struct	Video

struct	VideoResolution

Public Member Functions
bool	parseVideoEntityType (const rapidjson::Value &entityJson, VideoEntity::EntityType &entityType)

bool	parseActorEntity (const rapidjson::Value &entityJson, Actor &actor)

bool	parseAppEntity (const rapidjson::Value &entityJson, App &app)

bool	parseChannelEntity (const rapidjson::Value &entityJson, Channel &channel)

bool	parseCharacterEntity (const rapidjson::Value &entityJson, Character &character)

bool	parseDirectorEntity (const rapidjson::Value &entityJson, Director &director)

bool	parseEpisodeEntity (const rapidjson::Value &entityJson, Episode &episode)

bool	parseEventEntity (const rapidjson::Value &entityJson, Event &event)

bool	parseFranchiseEntity (const rapidjson::Value &entityJson, Franchise &franchise)

bool	parseGenreEntity (const rapidjson::Value &entityJson, Genre &genre)

bool	parseLeagueEntity (const rapidjson::Value &entityJson, League &league)

bool	parseMediaEntity (const rapidjson::Value &entityJson, Media &media)

bool	parsePopularityEntity (const rapidjson::Value &entityJson, Popularity &popularity)

bool	parseProductionCompanyEntity (const rapidjson::Value &entityJson, ProductionCompany &productionCompany)

bool	parseRecencyEntity (const rapidjson::Value &entityJson, Recency &recency)

bool	parseSeasonEntity (const rapidjson::Value &entityJson, Season &season)

bool	parseSportEntity (const rapidjson::Value &entityJson, Sport &sport)

bool	parseSportsTeamEntity (const rapidjson::Value &entityJson, SportsTeam &sportsTeam)

bool	parseVideoEntity (const rapidjson::Value &entityJson, Video &video)

bool	parseVideoResolutionEntity (const rapidjson::Value &entityJson, VideoResolution &videoResolution)

Static Public Member Functions
static std::string	convertEntityTypeToString (const VideoEntity::EntityType &entityType)

Detailed Description

A helper class that provides an aggregation of all video entity types. Users can ask Alexa to search for video content by specifying characteristics of the content, such as a season and episode of a TV show, or a genre of movie. Alexa sends these characteristics, called entity types for searching the requested content. This class also provides methods to parse the entity payload into respective types.

See also: https://developer.amazon.com/en-US/docs/alexa/video/entity-types-for-video-content.html

Member Enumeration Documentation

◆ EntityType

enum alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::EntityType

strong

Enum definitions for all video entity types.

Enumerator
ACTOR	An actor credited in video media content.
APP	An application that the user might launch, such as Prime Video.
CHANNEL	Represents the identifying data for a television channel.
CHARACTER	A character in a movie or TV show.
DIRECTOR	A director credited in video media content.
EPISODE	Episode number for serial content.
EVENT	A type of event, such as a music concert or sporting event.
FRANCHISE	Related video entities, such as a trilogy or five part series.
GENRE	Category of video content, such as action, drama, or comedy.
LEAGUE	Represents the name of a sporting league.
MEDIA_TYPE	Type category of the video content, such as movie or TV show.
POPULARITY	Indicates whether the user asks for popular content.
PRODUCTION_COMPANY	Production company name for the video media content.
RECENCY	Indicates whether the user content is new or old.
SEASON	Season number for serial content.
SPORT	Category of a sport, such as football.
SPORTS_TEAM	Name of a professional sports team.
VIDEO	Identifying data for the piece of video content, such as the movie title.
VIDEO_RESOLUTION	Represents the requested video resolution, such as HD.

Member Function Documentation

◆ convertEntityTypeToString()

static std::string alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::convertEntityTypeToString ( const VideoEntity::EntityType & entityType )

static

Convert Video Entity type to its corresponding string.

Parameters

entityType the video entity type.

Returns: the string corresponding to the entity type.

◆ parseActorEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseActorEntity	(	const rapidjson::Value &	entityJson,
		Actor &	actor
	)

Parse video entity of type Actor.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	actor	Parsed `Media` object.

Returns: true if parsing is successful.

◆ parseAppEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseAppEntity	(	const rapidjson::Value &	entityJson,
		App &	app
	)

Parse video entity of type App.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	actor	Parsed `Media` object.

Returns: true if parsing is successful.

◆ parseChannelEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseChannelEntity	(	const rapidjson::Value &	entityJson,
		Channel &	channel
	)

Parse video entity of type Channel.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	channel	Parsed `Channel` object.

Returns: true if parsing is successful.

◆ parseCharacterEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseCharacterEntity	(	const rapidjson::Value &	entityJson,
		Character &	character
	)

Parse video entity of type Character.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	character	Parsed `Character` object.

Returns: true if parsing is successful.

◆ parseDirectorEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseDirectorEntity	(	const rapidjson::Value &	entityJson,
		Director &	director
	)

Parse video entity of type Director.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	director	Parsed `Director` object.

Returns: true if parsing is successful.

◆ parseEpisodeEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseEpisodeEntity	(	const rapidjson::Value &	entityJson,
		Episode &	episode
	)

Parse video entity of type Episode.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	episode	Parsed `Episode` object.

Returns: true if parsing is successful.

◆ parseEventEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseEventEntity	(	const rapidjson::Value &	entityJson,
		Event &	event
	)

Parse video entity of type Event.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	event	Parsed `Event` object.

Returns: true if parsing is successful.

◆ parseFranchiseEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseFranchiseEntity	(	const rapidjson::Value &	entityJson,
		Franchise &	franchise
	)

Parse video entity of type Franchise.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	franchise	Parsed `Franchise` object.

Returns: true if parsing is successful.

◆ parseGenreEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseGenreEntity	(	const rapidjson::Value &	entityJson,
		Genre &	genre
	)

Parse video entity of type Genre.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	genre	Parsed `Genre` object.

Returns: true if parsing is successful.

◆ parseLeagueEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseLeagueEntity	(	const rapidjson::Value &	entityJson,
		League &	league
	)

Parse video entity of type League.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	league	Parsed `Media` object.

Returns: true if parsing is successful.

◆ parseMediaEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseMediaEntity	(	const rapidjson::Value &	entityJson,
		Media &	media
	)

Parse video entity of type Media.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	media	Parsed `Media` object.

Returns: true if parsing is successful.

◆ parsePopularityEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parsePopularityEntity	(	const rapidjson::Value &	entityJson,
		Popularity &	popularity
	)

Parse video entity of type Popularity.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	popularity	Parsed `Popularity` object.

Returns: true if parsing is successful.

◆ parseProductionCompanyEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseProductionCompanyEntity	(	const rapidjson::Value &	entityJson,
		ProductionCompany &	productionCompany
	)

Parse video entity of type ProductionCompany.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	actor	Parsed `ProductionCompany` object.

Returns: true if parsing is successful.

◆ parseRecencyEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseRecencyEntity	(	const rapidjson::Value &	entityJson,
		Recency &	recency
	)

Parse video entity of type Recency.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	recency	Parsed `Recency` object.

Returns: true if parsing is successful.

◆ parseSeasonEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseSeasonEntity	(	const rapidjson::Value &	entityJson,
		Season &	season
	)

Parse video entity of type Season.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	season	Parsed `Season` object.

Returns: true if parsing is successful.

◆ parseSportEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseSportEntity	(	const rapidjson::Value &	entityJson,
		Sport &	sport
	)

Parse video entity of type Sport.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	sport	Parsed `Sport` object.

Returns: true if parsing is successful.

◆ parseSportsTeamEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseSportsTeamEntity	(	const rapidjson::Value &	entityJson,
		SportsTeam &	sportsTeam
	)

Parse video entity of type SportsTeam.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	sportsTeam	Parsed `SportsTeam` object.

Returns: true if parsing is successful.

◆ parseVideoEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseVideoEntity	(	const rapidjson::Value &	entityJson,
		Video &	video
	)

Parse video entity of type Video.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	video	Parsed `Video` object.

Returns: true if parsing is successful.

◆ parseVideoEntityType()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseVideoEntityType	(	const rapidjson::Value &	entityJson,
		VideoEntity::EntityType &	entityType
	)

Parse input json to determine if it contains a video entity type.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	entityType	Parsed `entity` type object.

Returns: true if json contains a video entity type, false otherwise.

◆ parseVideoResolutionEntity()

bool alexaClientSDK::acsdkAlexaVideoCommon::VideoEntity::parseVideoResolutionEntity	(	const rapidjson::Value &	entityJson,
		VideoResolution &	videoResolution
	)

Parse video entity of type VideoResolution.

Parameters

[in]	entityJson	RapidJson object with the entity json to be parsed.
[out]	videoResolution	Parsed `VideoResolution` object.

Returns: true if parsing is successful.

The documentation for this class was generated from the following file:

/workplace/avs-device-sdk/capabilities/AlexaVideoCommon/VideoContent/include/acsdk/VideoContent/VideoEntityTypes.h

Public Types
enum	EntityType { EntityType::ACTOR, EntityType::APP, EntityType::CHANNEL, EntityType::CHARACTER, EntityType::DIRECTOR, EntityType::EPISODE, EntityType::EVENT, EntityType::FRANCHISE, EntityType::GENRE, EntityType::LEAGUE, EntityType::MEDIA_TYPE, EntityType::POPULARITY, EntityType::PRODUCTION_COMPANY, EntityType::RECENCY, EntityType::SEASON, EntityType::SPORT, EntityType::SPORTS_TEAM, EntityType::VIDEO, EntityType::VIDEO_RESOLUTION }

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ EntityType

Member Function Documentation

◆ convertEntityTypeToString()

◆ parseActorEntity()

◆ parseAppEntity()

◆ parseChannelEntity()

◆ parseCharacterEntity()

◆ parseDirectorEntity()

◆ parseEpisodeEntity()

◆ parseEventEntity()

◆ parseFranchiseEntity()

◆ parseGenreEntity()

◆ parseLeagueEntity()

◆ parseMediaEntity()

◆ parsePopularityEntity()

◆ parseProductionCompanyEntity()

◆ parseRecencyEntity()

◆ parseSeasonEntity()

◆ parseSportEntity()

◆ parseSportsTeamEntity()

◆ parseVideoEntity()

◆ parseVideoEntityType()

◆ parseVideoResolutionEntity()