VideoObject interface

Reference

Package:: @azure/cognitiveservices-videosearch

Defines a video object that is relevant to the query.

Properties

allowHttpsEmbed	NOTE: This property will not be serialized. It can only be populated by the server.
allowMobileEmbed	NOTE: This property will not be serialized. It can only be populated by the server.
alternateName	NOTE: This property will not be serialized. It can only be populated by the server.
bingId	An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
contentUrl	Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). NOTE: This property will not be serialized. It can only be populated by the server.
description	A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.
embedHtml	NOTE: This property will not be serialized. It can only be populated by the server.
height	The height of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.
hostPageUrl	URL of the page that hosts the media object. NOTE: This property will not be serialized. It can only be populated by the server.
id	A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
image	NOTE: This property will not be serialized. It can only be populated by the server.
isSuperfresh	NOTE: This property will not be serialized. It can only be populated by the server.
motionThumbnailId	NOTE: This property will not be serialized. It can only be populated by the server.
motionThumbnailUrl	NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
provider	The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.
text	NOTE: This property will not be serialized. It can only be populated by the server.
thumbnail	NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUrl	The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.
url	The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
videoId	NOTE: This property will not be serialized. It can only be populated by the server.
viewCount	NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl	The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.
width	The width of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowHttpsEmbed

NOTE: This property will not be serialized. It can only be populated by the server.

allowHttpsEmbed?: boolean

Property Value

boolean

allowMobileEmbed

NOTE: This property will not be serialized. It can only be populated by the server.

allowMobileEmbed?: boolean

Property Value

boolean

alternateName

NOTE: This property will not be serialized. It can only be populated by the server.

alternateName?: string

Property Value

string

bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.

bingId?: string

Property Value

string

contentUrl

Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). NOTE: This property will not be serialized. It can only be populated by the server.

contentUrl?: string

Property Value

string

description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

embedHtml

NOTE: This property will not be serialized. It can only be populated by the server.

embedHtml?: string

Property Value

string

height

The height of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

height?: number

Property Value

number

hostPageUrl

URL of the page that hosts the media object. NOTE: This property will not be serialized. It can only be populated by the server.

hostPageUrl?: string

Property Value

string

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

image

NOTE: This property will not be serialized. It can only be populated by the server.

image?: ImageObject

Property Value

ImageObject

isSuperfresh

NOTE: This property will not be serialized. It can only be populated by the server.

isSuperfresh?: boolean

Property Value

boolean

motionThumbnailId

NOTE: This property will not be serialized. It can only be populated by the server.

motionThumbnailId?: string

Property Value

string

motionThumbnailUrl

NOTE: This property will not be serialized. It can only be populated by the server.

motionThumbnailUrl?: string

Property Value

string

name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.

provider?: ThingUnion[]

Property Value

ThingUnion[]

text

NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string

thumbnail

NOTE: This property will not be serialized. It can only be populated by the server.

thumbnail?: ImageObject

Property Value

ImageObject

thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnailUrl?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

videoId

NOTE: This property will not be serialized. It can only be populated by the server.

videoId?: string

Property Value

string

viewCount

NOTE: This property will not be serialized. It can only be populated by the server.

viewCount?: number

Property Value

number

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string

width

The width of the source media object, in pixels. NOTE: This property will not be serialized. It can only be populated by the server.

width?: number

Property Value

number

Share via

VideoObject interface

Properties

Property Details

allowHttpsEmbed

Property Value

allowMobileEmbed

Property Value

alternateName

Property Value

bingId

Property Value

contentUrl

Property Value

description

Property Value

embedHtml

Property Value

height

Property Value

hostPageUrl

Property Value

id

Property Value

image

Property Value

isSuperfresh

Property Value

motionThumbnailId

Property Value

motionThumbnailUrl

Property Value

name

Property Value

provider

Property Value

text

Property Value

thumbnail

Property Value

thumbnailUrl

Property Value

url

Property Value

videoId

Property Value

viewCount

Property Value

webSearchUrl

Property Value

width

Property Value

Additional resources