Interface GoogleApiYouTubeVideoResource

Index

Properties

Properties

public contentDetails: { duration: string; dimension: string; definition: string; caption: string; licensedContent: boolean; regionRestriction: { allowed: string[]; blocked: string[]; }; contentRating: { mpaaRating: string; tvpgRating: string; bbfcRating: string; chvrsRating: string; eirinRating: string; cbfcRating: string; fmocRating: string; icaaRating: string; acbRating: string; oflcRating: string; fskRating: string; kmrbRating: string; djctqRating: string; russiaRating: string; rtcRating: string; }; }

The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.

public contentDetails.caption: string

Indicates whether captions are available for the video.

public contentDetails.contentRating: { mpaaRating: string; tvpgRating: string; bbfcRating: string; chvrsRating: string; eirinRating: string; cbfcRating: string; fmocRating: string; icaaRating: string; acbRating: string; oflcRating: string; fskRating: string; kmrbRating: string; djctqRating: string; russiaRating: string; rtcRating: string; }

Specifies the ratings that the video received under various rating schemes.

public contentDetails.definition: string

Indicates whether the video is available in high definition (HD) or only in standard definition.

public contentDetails.dimension: string

Indicates whether the video is available in 3D or in 2D.

public contentDetails.duration: string

The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video.

public contentDetails.licensedContent: boolean

Indicates whether the video represents licensed content, which means that the content has been claimed by a YouTube content partner.

public contentDetails.regionRestriction: { allowed: string[]; blocked: string[]; }

The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.

public contentRating.acbRating: string

The videos Australian Classification Board (ACB) rating.

public contentRating.bbfcRating: string

The videos British Board of Film Classification (BBFC) rating.

public contentRating.cbfcRating: string

The videos Central Board of Film Certification (CBFC - India) rating.

public contentRating.chvrsRating: string

The videos Canadian Home Video Rating System (CHVRS) rating.

public contentRating.djctqRating: string

The videos Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating.

public contentRating.eirinRating: string

The videos Eirin rating. Eirin is the Japanese rating system.

public contentRating.fmocRating: string

The videos Centre national du cinéma et de limage animé (French Ministry of Culture) rating.

public contentRating.fskRating: string

The videos Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating.

public contentRating.icaaRating: string

The videos Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating.

public contentRating.kmrbRating: string

The videos Korea Media Rating Board rating. The KMRB rates videos in South Korea.

public contentRating.mpaaRating: string

The videos Motion Picture Association of America (MPAA) rating.

public contentRating.oflcRating: string

The videos Office of Film and Literature Classification (OFLC - New Zealand) rating.

public contentRating.rtcRating: string

The videos General Directorate of Radio, Television and Cinematography (Mexico) rating.

public contentRating.russiaRating: string

The videos National Film Registry of the Russian Federation (MKRF - Russia) rating.

public contentRating.tvpgRating: string

The videos TV Parental Guidelines (TVPG) rating.

public regionRestriction.allowed: Array<string>

A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.

public regionRestriction.blocked: Array<string>

A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.

public etag: string

The ETag of the video resource.

public fileDetails: { fileName: string; fileSize: number; fileType: string; container: string; videoStreams: { widthPixels: number; heightPixels: number; frameRateFps: number; aspectRatio: number; codec: string; bitrateBps: number; rotation: string; vender: string; }[]; audioStreams: { channelCount: number; codec: string; bitrateBps: number; vendor: string; }[]; durationMs: number; bitrateBps: number; recordingLocation: { latitude: number; longitude: number; elevation: number; }; creationTime: string; }

The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the files resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.

public fileDetails.audioStreams: Array<{ channelCount: number; codec: string; bitrateBps: number; vendor: string; }>

A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.

public fileDetails.bitrateBps: number

The uploaded video files combined (video and audio) bitrate in bits per second.

public fileDetails.container: string

The uploaded video files container format.

public fileDetails.creationTime: string

The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:

public fileDetails.durationMs: number

The length of the uploaded video in milliseconds.

public fileDetails.fileName: string

The uploaded files name. This field is present whether a video file or another type of file was uploaded.

public fileDetails.fileSize: number

The uploaded files size in bytes. This field is present whether a video file or another type of file was uploaded.

public fileDetails.fileType: string

The uploaded files type as detected by YouTubes video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.

public fileDetails.recordingLocation: { latitude: number; longitude: number; elevation: number; }

Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.

public fileDetails.videoStreams: Array<{ widthPixels: number; heightPixels: number; frameRateFps: number; aspectRatio: number; codec: string; bitrateBps: number; rotation: string; vender: string; }>

A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.

public recordingLocation.elevation: number

Altitude above the WGS 84 reference ellipsoid, in meters.

public recordingLocation.latitude: number

Latitude in degrees.

public recordingLocation.longitude: number

Longitude in degrees.

public id: string

The ID that YouTube uses to uniquely identify the video.

public kind: string

The type of the API resource. For video resources, the value will be youtube#video.

public player: { embedHtml: string; }

The player object contains information that you would use to play the video in an embedded player.

public player.embedHtml: string

An