goog.ui.media.YoutubeModel

Provided By	`goog.ui.media.YoutubeModel`
Extends	`goog.ui.media.MediaModel`

The goog.ui.media.Youtube media data model. It stores a required videoId field, sets the youtube URL, and allows a few optional parameters.

new YoutubeModel( `videoId`, `opt_caption`, `opt_description` )

Parameters

`videoId`	`string`
	The youtube video id.
`opt_caption`	`string=`
	An optional caption of the youtube video.
`opt_description`	`string=`
	An optional description of the youtube video.

VIEW SOURCE

Instance Methods

Finds the first category with the given scheme.

Defined by

goog.ui.media.MediaModel

Parameters

`scheme`	`string`
	The scheme to search for.

Returns

(goog.ui.media.MediaModel.Category|null)

The category that has the given scheme. May be null.

VIEW SOURCE

Finds all credits with the given role.

Defined by

goog.ui.media.MediaModel

Parameters

`role`	`string`
	The role to search for.

Returns

Array<goog.ui.media.MediaModel.Credit>

An array of credits with the given role. May be empty.

VIEW SOURCE

Gets the caption of this media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(string|undefined)

The caption of the media.

VIEW SOURCE

Gets the categories of the media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(Array<(goog.ui.media.MediaModel.Category|null)>|null)

The categories of the media.

VIEW SOURCE

Gets the credits of the media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

Array<(goog.ui.media.MediaModel.Credit|null)>

The credits of the media.

VIEW SOURCE

Gets the description of this media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(string|undefined)

The description of the media.

VIEW SOURCE

Gets the duration of the media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(number|undefined)

The duration in seconds.

VIEW SOURCE

Gets the height of the media in pixels.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(number|undefined)

The height in pixels.

VIEW SOURCE

Gets the media medium.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(goog.ui.media.MediaModel.Medium|undefined)

The media medium.

VIEW SOURCE

Gets the player data.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(goog.ui.media.MediaModel.Player|null|undefined)

The media player data.

VIEW SOURCE

Gets the subtitles for the media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(Array<(goog.ui.media.MediaModel.SubTitle|null)>|null)

The subtitles.

VIEW SOURCE

Gets the thumbnail urls.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(Array<(goog.ui.media.MediaModel.Thumbnail|null)>|null)

The list of thumbnails.

VIEW SOURCE

Gets the media mime type.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(goog.ui.media.MediaModel.MimeType|undefined)

The media mime type.

VIEW SOURCE

Gets the URL of this media.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(string|undefined)

The URL of the media.

VIEW SOURCE

Gets the Youtube video id.

Parameters

None.

Returns

string

The Youtube video id.

VIEW SOURCE

Gets the width of the media in pixels.

Defined by

goog.ui.media.MediaModel

Parameters

None.

Returns

(number|undefined)

The width in pixels.

VIEW SOURCE

Sets the caption of this media.

Defined by

goog.ui.media.MediaModel

Parameters

`caption`	`string`
	The caption of the media.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the categories of the media

Defined by

goog.ui.media.MediaModel

Parameters

`categories`	`(Array<(goog.ui.media.MediaModel.Category\|null)>\|null)`
	The categories of the media.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the credits of the media

Defined by

goog.ui.media.MediaModel

Parameters

`credits`	`Array<(goog.ui.media.MediaModel.Credit\|null)>`
	The credits of the media.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the description of this media.

Defined by

goog.ui.media.MediaModel

Parameters

`description`	`string`
	The description of the media.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets duration of the media.

Defined by

goog.ui.media.MediaModel

Parameters

`duration`	`number`
	The duration of the media, in seconds.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the height of the media.

Defined by

goog.ui.media.MediaModel

Parameters

`height`	`number`
	The height of the media, in pixels.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the media medium.

Defined by

goog.ui.media.MediaModel

Parameters

`medium`	`goog.ui.media.MediaModel.Medium`
	The media medium.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the player data.

Defined by

goog.ui.media.MediaModel

Parameters

`player`	`(goog.ui.media.MediaModel.Player\|null)`
	The media player data.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the subtitles for the media

Defined by

goog.ui.media.MediaModel

Parameters

`subtitles`	`(Array<(goog.ui.media.MediaModel.SubTitle\|null)>\|null)`
	The subtitles.

Returns

goog.ui.media.MediaModel

The object itself.

VIEW SOURCE

Sets the thumbnail list.

Defined by

goog.ui.media.MediaModel

Parameters

`thumbnails`	`(Array<(goog.ui.media.MediaModel.Thumbnail\|null)>\|null)`
	The list of thumbnail.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the media mime type.

Defined by

goog.ui.media.MediaModel

Parameters

`type`	`goog.ui.media.MediaModel.MimeType`
	The media mime type.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the URL of this media.

Defined by

goog.ui.media.MediaModel

Parameters

`url`	`string`
	The URL of the media.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Sets the width of the media.

Defined by

goog.ui.media.MediaModel

Parameters

`width`	`number`
	The width of the media, in pixels.

Returns

goog.ui.media.MediaModel

The object itself, used for chaining.

VIEW SOURCE

Static Functions

The opposite of goog.ui.media.Youtube.newInstance: it takes a videoId and returns a youtube URL.

Parameters

`videoId`	`string`
	The youtube video ID.

Returns

string

The youtube URL.

VIEW SOURCE

A static auxiliary method that builds URL of the flash movie to be embedded, out of the youtube video id.

Parameters

`videoId`	`string`
	The youtube video ID.
`opt_autoplay`	`boolean=`
	Whether the flash movie should start playing as soon as it is shown, or if it should show a 'play' button.

Returns

goog.html.TrustedResourceUrl

The flash URL to be embedded on the page.

VIEW SOURCE

A static auxiliary method that builds a static image URL with a preview of the youtube video.

NOTE(goto): patterned after Gmail's gadgets/youtube,

TODO(goto): how do I specify the width/height of the resulting image on the url ? is there an official API for https://ytimg.com ?

Parameters

`youtubeId`	`string`
	The youtube video ID.

Returns

string

An URL that contains an image with a preview of the youtube movie.

VIEW SOURCE

A auxiliary static method that parses a youtube URL, extracting the ID of the video, and builds a YoutubeModel.

Parameters

`youtubeUrl`	`string`
	A youtube URL.
`opt_caption`	`string=`
	An optional caption of the youtube video.
`opt_description`	`string=`
	An optional description of the youtube video.

Returns

goog.ui.media.YoutubeModel

The data model that represents the youtube URL.

Throws

Error in case the parsing fails.

goog.ui.media.YoutubeModel

new YoutubeModel( `videoId`, `opt_caption`, `opt_description` )

Instance Methods

`this.`findCategoryWithScheme( `scheme` ) `→` `(goog.ui.media.MediaModel.Category|null)`

`this.`findCreditsWithRole( `role` ) `→` `Array<goog.ui.media.MediaModel.Credit>`

`this.`getCaption() `→` `(string|undefined)`

`this.`getCategories() `→` `(Array<(goog.ui.media.MediaModel.Category|null)>|null)`

`this.`getCredits() `→` `Array<(goog.ui.media.MediaModel.Credit|null)>`

`this.`getDescription() `→` `(string|undefined)`

`this.`getDuration() `→` `(number|undefined)`

`this.`getHeight() `→` `(number|undefined)`

`this.`getMedium() `→` `(goog.ui.media.MediaModel.Medium|undefined)`

`this.`getPlayer() `→` `(goog.ui.media.MediaModel.Player|null|undefined)`

`this.`getSubTitles() `→` `(Array<(goog.ui.media.MediaModel.SubTitle|null)>|null)`

`this.`getThumbnails() `→` `(Array<(goog.ui.media.MediaModel.Thumbnail|null)>|null)`

`this.`getType() `→` `(goog.ui.media.MediaModel.MimeType|undefined)`

`this.`getUrl() `→` `(string|undefined)`

`this.`getVideoId() `→` `string`

`this.`getWidth() `→` `(number|undefined)`

`this.`setCaption( `caption` ) `→` `goog.ui.media.MediaModel`

`this.`setCategories( `categories` ) `→` `goog.ui.media.MediaModel`

`this.`setCredits( `credits` ) `→` `goog.ui.media.MediaModel`

`this.`setDescription( `description` ) `→` `goog.ui.media.MediaModel`

`this.`setDuration( `duration` ) `→` `goog.ui.media.MediaModel`

`this.`setHeight( `height` ) `→` `goog.ui.media.MediaModel`

`this.`setMedium( `medium` ) `→` `goog.ui.media.MediaModel`

`this.`setPlayer( `player` ) `→` `goog.ui.media.MediaModel`

`this.`setSubTitles( `subtitles` ) `→` `goog.ui.media.MediaModel`

`this.`setThumbnails( `thumbnails` ) `→` `goog.ui.media.MediaModel`

`this.`setType( `type` ) `→` `goog.ui.media.MediaModel`

`this.`setUrl( `url` ) `→` `goog.ui.media.MediaModel`

`this.`setWidth( `width` ) `→` `goog.ui.media.MediaModel`

Static Functions

YoutubeModel.buildUrl( `videoId` ) `→` `string`

YoutubeModel.getFlashUrl( `videoId`, `opt_autoplay` ) `→` `goog.html.TrustedResourceUrl`

YoutubeModel.getThumbnailUrl( `youtubeId` ) `→` `string`

YoutubeModel.newInstance( `youtubeUrl`, `opt_caption`, `opt_description` ) `→` `goog.ui.media.YoutubeModel`

goog.ui.media.YoutubeModel

new YoutubeModel( videoId, opt_caption, opt_description )

Instance Methods

this.findCategoryWithScheme( scheme ) → (goog.ui.media.MediaModel.Category|null)

this.findCreditsWithRole( role ) → Array<goog.ui.media.MediaModel.Credit>

this.getCaption() → (string|undefined)

this.getCategories() → (Array<(goog.ui.media.MediaModel.Category|null)>|null)

this.getCredits() → Array<(goog.ui.media.MediaModel.Credit|null)>

this.getDescription() → (string|undefined)

this.getDuration() → (number|undefined)

this.getHeight() → (number|undefined)

this.getMedium() → (goog.ui.media.MediaModel.Medium|undefined)

this.getPlayer() → (goog.ui.media.MediaModel.Player|null|undefined)

this.getSubTitles() → (Array<(goog.ui.media.MediaModel.SubTitle|null)>|null)

this.getThumbnails() → (Array<(goog.ui.media.MediaModel.Thumbnail|null)>|null)

this.getType() → (goog.ui.media.MediaModel.MimeType|undefined)

this.getUrl() → (string|undefined)

this.getVideoId() → string

this.getWidth() → (number|undefined)

this.setCaption( caption ) → goog.ui.media.MediaModel

this.setCategories( categories ) → goog.ui.media.MediaModel

this.setCredits( credits ) → goog.ui.media.MediaModel

this.setDescription( description ) → goog.ui.media.MediaModel

this.setDuration( duration ) → goog.ui.media.MediaModel

this.setHeight( height ) → goog.ui.media.MediaModel

this.setMedium( medium ) → goog.ui.media.MediaModel

this.setPlayer( player ) → goog.ui.media.MediaModel

this.setSubTitles( subtitles ) → goog.ui.media.MediaModel

this.setThumbnails( thumbnails ) → goog.ui.media.MediaModel

this.setType( type ) → goog.ui.media.MediaModel

this.setUrl( url ) → goog.ui.media.MediaModel

this.setWidth( width ) → goog.ui.media.MediaModel

Static Functions

YoutubeModel.buildUrl( videoId ) → string

YoutubeModel.getFlashUrl( videoId, opt_autoplay ) → goog.html.TrustedResourceUrl

YoutubeModel.getThumbnailUrl( youtubeId ) → string

YoutubeModel.newInstance( youtubeUrl, opt_caption, opt_description ) → goog.ui.media.YoutubeModel

new YoutubeModel( `videoId`, `opt_caption`, `opt_description` )

`this.`findCategoryWithScheme( `scheme` ) `→` `(goog.ui.media.MediaModel.Category|null)`

`this.`findCreditsWithRole( `role` ) `→` `Array<goog.ui.media.MediaModel.Credit>`

`this.`getCaption() `→` `(string|undefined)`

`this.`getCategories() `→` `(Array<(goog.ui.media.MediaModel.Category|null)>|null)`

`this.`getCredits() `→` `Array<(goog.ui.media.MediaModel.Credit|null)>`

`this.`getDescription() `→` `(string|undefined)`

`this.`getDuration() `→` `(number|undefined)`

`this.`getHeight() `→` `(number|undefined)`

`this.`getMedium() `→` `(goog.ui.media.MediaModel.Medium|undefined)`

`this.`getPlayer() `→` `(goog.ui.media.MediaModel.Player|null|undefined)`

`this.`getSubTitles() `→` `(Array<(goog.ui.media.MediaModel.SubTitle|null)>|null)`

`this.`getThumbnails() `→` `(Array<(goog.ui.media.MediaModel.Thumbnail|null)>|null)`

`this.`getType() `→` `(goog.ui.media.MediaModel.MimeType|undefined)`

`this.`getUrl() `→` `(string|undefined)`

`this.`getVideoId() `→` `string`

`this.`getWidth() `→` `(number|undefined)`

`this.`setCaption( `caption` ) `→` `goog.ui.media.MediaModel`

`this.`setCategories( `categories` ) `→` `goog.ui.media.MediaModel`

`this.`setCredits( `credits` ) `→` `goog.ui.media.MediaModel`

`this.`setDescription( `description` ) `→` `goog.ui.media.MediaModel`

`this.`setDuration( `duration` ) `→` `goog.ui.media.MediaModel`

`this.`setHeight( `height` ) `→` `goog.ui.media.MediaModel`

`this.`setMedium( `medium` ) `→` `goog.ui.media.MediaModel`

`this.`setPlayer( `player` ) `→` `goog.ui.media.MediaModel`

`this.`setSubTitles( `subtitles` ) `→` `goog.ui.media.MediaModel`

`this.`setThumbnails( `thumbnails` ) `→` `goog.ui.media.MediaModel`

`this.`setType( `type` ) `→` `goog.ui.media.MediaModel`

`this.`setUrl( `url` ) `→` `goog.ui.media.MediaModel`

`this.`setWidth( `width` ) `→` `goog.ui.media.MediaModel`

YoutubeModel.buildUrl( `videoId` ) `→` `string`

YoutubeModel.getFlashUrl( `videoId`, `opt_autoplay` ) `→` `goog.html.TrustedResourceUrl`

YoutubeModel.getThumbnailUrl( `youtubeId` ) `→` `string`

YoutubeModel.newInstance( `youtubeUrl`, `opt_caption`, `opt_description` ) `→` `goog.ui.media.YoutubeModel`