YouTubePHP Documentation

VideoSnippet 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.

Basic details about a video, including title, description, uploader, thumbnails and category.

Tags
since
1.0.0

Table of Contents

Constants

LIVE_BROADCAST_CONTENT_COMPLETED  : mixed = 'completed'
The live broadcast has been completed.
LIVE_BROADCAST_CONTENT_LIVE  : mixed = 'live'
The live broadcast is active.
LIVE_BROADCAST_CONTENT_NONE  : mixed = 'none'
The resource does not have live broadcast content.
LIVE_BROADCAST_CONTENT_UPCOMING  : mixed = 'upcoming'
The live broadcast is upcoming.

Properties

$categoryId  : string|null
$channelId  : string|null
$channelTitle  : string|null
$defaultAudioLanguage  : string|null
$defaultLanguage  : string|null
$description  : string|null
$liveBroadcastContent  : string|null
$localized  : VideoLocalization|null
$publishedAt  : CarbonImmutable|null
$tags  : array<int, string>|null
$thumbnails  : ThumbnailDetails|null
$title  : string|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

LIVE_BROADCAST_CONTENT_COMPLETED

The live broadcast has been completed.

public mixed LIVE_BROADCAST_CONTENT_COMPLETED = 'completed'

LIVE_BROADCAST_CONTENT_LIVE

The live broadcast is active.

public mixed LIVE_BROADCAST_CONTENT_LIVE = 'live'

LIVE_BROADCAST_CONTENT_NONE

The resource does not have live broadcast content.

public mixed LIVE_BROADCAST_CONTENT_NONE = 'none'

LIVE_BROADCAST_CONTENT_UPCOMING

The live broadcast is upcoming.

public mixed LIVE_BROADCAST_CONTENT_UPCOMING = 'upcoming'

Properties

$categoryId

public string|null $categoryId

The YouTube video category associated with the video.

$channelId

public string|null $channelId

The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.

$channelTitle

public string|null $channelTitle

Channel title for the channel that the video belongs to.

$defaultAudioLanguage

public string|null $defaultAudioLanguage

The default_audio_language property specifies the language spoken in the video's default audio track.

$defaultLanguage

public string|null $defaultLanguage

The language of the videos's default snippet.

$description

public string|null $description

The video's description. @mutable youtube.videos.insert youtube.videos.update

$liveBroadcastContent

public string|null $liveBroadcastContent

Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. One of the LIVE_BROADCAST_CONTENT_* constants.

$localized

public VideoLocalization|null $localized

Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)

$publishedAt

public CarbonImmutable|null $publishedAt

The date and time when the video was uploaded.

$tags

public array<int, string>|null $tags

A list of keyword tags associated with the video. Tags may contain spaces.

$thumbnails

public ThumbnailDetails|null $thumbnails

A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

$title

public string|null $title

The video's title. @mutable youtube.videos.insert youtube.videos.update

$casts

Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.

protected array<string, string> $casts = ['localized' => 'VideoLocalization', 'thumbnails' => 'ThumbnailDetails']

$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 = ['publishedAt']

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
bool

fill()

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
throws
LogicException

When the part was built without one.

Return values
YouTube

jsonSerialize()

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
bool

offsetGet()

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
Factory

setRawAttribute()

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
On this page

Search results