VideoFileDetailsVideoStream
extends Part
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
Information about a video stream.
Tags
Table of Contents
Constants
- ROTATION_CLOCKWISE : mixed = 'clockwise'
- A `rotation` of `clockwise`.
- ROTATION_COUNTER_CLOCKWISE : mixed = 'counterClockwise'
- A `rotation` of `counterClockwise`.
- ROTATION_NONE : mixed = 'none'
- A `rotation` of `none`.
- ROTATION_OTHER : mixed = 'other'
- A `rotation` of `other`.
- ROTATION_UPSIDE_DOWN : mixed = 'upsideDown'
- A `rotation` of `upsideDown`.
Properties
- $aspectRatio : float|null
- $bitrateBps : string|null
- $codec : string|null
- $frameRateFps : float|null
- $heightPixels : int|null
- $rotation : string|null
- $vendor : string|null
- $widthPixels : int|null
- $casts : array<string, string>
- Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
- $dates : array<int, string>
- Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
- $youtube : ?YouTube
Methods
- __construct() : mixed
- __debugInfo() : array<string, mixed>
- __get() : mixed
- __isset() : bool
- __set() : void
- __toString() : string
- __unset() : void
- attributeExists() : bool
- fill() : void
- getAttribute() : mixed
- getCasts() : array<string, string>
- getDates() : array<int, string>
- getRawAttribute() : mixed
- Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
- getRawAttributes() : array<string, mixed>
- getYouTube() : YouTube
- The client this part came from.
- jsonSerialize() : array<string, mixed>
- The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
- offsetExists() : bool
- offsetGet() : mixed
- offsetSet() : void
- offsetUnset() : void
- setAttribute() : void
- factory() : Factory
- Builds another part from the same client - for nested objects.
- setRawAttribute() : void
- Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
Constants
ROTATION_CLOCKWISE
A `rotation` of `clockwise`.
public
mixed
ROTATION_CLOCKWISE
= 'clockwise'
ROTATION_COUNTER_CLOCKWISE
A `rotation` of `counterClockwise`.
public
mixed
ROTATION_COUNTER_CLOCKWISE
= 'counterClockwise'
ROTATION_NONE
A `rotation` of `none`.
public
mixed
ROTATION_NONE
= 'none'
ROTATION_OTHER
A `rotation` of `other`.
public
mixed
ROTATION_OTHER
= 'other'
ROTATION_UPSIDE_DOWN
A `rotation` of `upsideDown`.
public
mixed
ROTATION_UPSIDE_DOWN
= 'upsideDown'
Properties
$aspectRatio
public
float|null
$aspectRatio
The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
$bitrateBps
public
string|null
$bitrateBps
The video stream's bitrate, in bits per second. A 64-bit number, as a string.
$codec
public
string|null
$codec
The video codec that the stream uses.
$frameRateFps
public
float|null
$frameRateFps
The video stream's frame rate, in frames per second.
$heightPixels
public
int|null
$heightPixels
The encoded video content's height in pixels.
$rotation
public
string|null
$rotation
The amount that YouTube needs to rotate the original source content to
properly display the video. One of the ROTATION_* constants.
$vendor
public
string|null
$vendor
A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
$widthPixels
public
int|null
$widthPixels
The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= []
$dates
Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
protected
array<int, string>
$dates
= []
$youtube read-only
protected
?YouTube
$youtube
= null
Methods
__construct()
public
__construct([YouTube|null $youtube = null ][, array<string, mixed>|object $attributes = [] ]) : mixed
Parameters
- $youtube : YouTube|null = null
-
The client, for behaviour that calls the API.
- $attributes : array<string, mixed>|object = []
__debugInfo()
public
__debugInfo() : array<string, mixed>
Return values
array<string, mixed>__get()
public
__get(string $name) : mixed
Parameters
- $name : string
__isset()
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool__set()
public
__set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
__toString()
public
__toString() : string
Return values
string__unset()
public
__unset(string $name) : void
Parameters
- $name : string
attributeExists()
public
attributeExists(string $key) : bool
Parameters
- $key : string
Return values
boolfill()
public
fill(array<string, mixed> $attributes) : void
Parameters
- $attributes : array<string, mixed>
getAttribute()
public
getAttribute(string $key) : mixed
Parameters
- $key : string
getCasts()
public
getCasts() : array<string, string>
Return values
array<string, string>getDates()
public
getDates() : array<int, string>
Return values
array<int, string>getRawAttribute()
Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
public
getRawAttribute(string $key) : mixed
Parameters
- $key : string
getRawAttributes()
public
getRawAttributes() : array<string, mixed>
Return values
array<string, mixed>getYouTube()
The client this part came from.
public
getYouTube() : YouTube
Tags
Return values
YouTubejsonSerialize()
The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
setAttribute()
public
setAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
factory()
Builds another part from the same client - for nested objects.
protected
factory() : Factory
Return values
FactorysetRawAttribute()
Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
protected
setRawAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed