YouTubePHP Documentation

VideoStatus 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 category, such as its localized title. Next Id: 20

Tags
since
1.0.0

Table of Contents

Constants

FAILURE_REASON_CODEC  : mixed = 'codec'
Unsupported codec.
FAILURE_REASON_CONVERSION  : mixed = 'conversion'
Unable to convert video content.
FAILURE_REASON_EMPTY_FILE  : mixed = 'emptyFile'
Empty file.
FAILURE_REASON_INVALID_FILE  : mixed = 'invalidFile'
Invalid file format.
FAILURE_REASON_TOO_SMALL  : mixed = 'tooSmall'
File was too small.
FAILURE_REASON_UPLOAD_ABORTED  : mixed = 'uploadAborted'
Upload wasn't finished.
LICENSE_CREATIVE_COMMON  : mixed = 'creativeCommon'
Creative Commons license.
LICENSE_YOUTUBE  : mixed = 'youtube'
Standard YouTube license.
PRIVACY_STATUS_PRIVATE  : mixed = 'private'
A `privacyStatus` of `private`.
PRIVACY_STATUS_PUBLIC  : mixed = 'public'
A `privacyStatus` of `public`.
PRIVACY_STATUS_UNLISTED  : mixed = 'unlisted'
A `privacyStatus` of `unlisted`.
REJECTION_REASON_CLAIM  : mixed = 'claim'
Blocked by content owner.
REJECTION_REASON_COPYRIGHT  : mixed = 'copyright'
Copyright infringement.
REJECTION_REASON_DUPLICATE  : mixed = 'duplicate'
Duplicate upload in the same channel.
REJECTION_REASON_INAPPROPRIATE  : mixed = 'inappropriate'
Inappropriate video content.
REJECTION_REASON_LEGAL  : mixed = 'legal'
An unspecified legal reason.
REJECTION_REASON_LENGTH  : mixed = 'length'
Video duration was too long.
REJECTION_REASON_TERMS_OF_USE  : mixed = 'termsOfUse'
Terms of use violation.
REJECTION_REASON_TRADEMARK  : mixed = 'trademark'
Trademark infringement.
REJECTION_REASON_UPLOADER_ACCOUNT_CLOSED  : mixed = 'uploaderAccountClosed'
Uploader closed his/her account.
REJECTION_REASON_UPLOADER_ACCOUNT_SUSPENDED  : mixed = 'uploaderAccountSuspended'
Uploader account was suspended.
UPLOAD_STATUS_DELETED  : mixed = 'deleted'
Video has been deleted.
UPLOAD_STATUS_FAILED  : mixed = 'failed'
Processing has failed. See FailureReason.
UPLOAD_STATUS_PROCESSED  : mixed = 'processed'
Video has been successfully processed.
UPLOAD_STATUS_REJECTED  : mixed = 'rejected'
Video has been rejected. See RejectionReason.
UPLOAD_STATUS_UPLOADED  : mixed = 'uploaded'
Video has been uploaded but not processed yet.

Properties

$containsSyntheticMedia  : bool|null
$embeddable  : bool|null
$failureReason  : string|null
$license  : string|null
$madeForKids  : bool|null
$privacyStatus  : string|null
$publicStatsViewable  : bool|null
$publishAt  : CarbonImmutable|null
$rejectionReason  : string|null
$selfDeclaredMadeForKids  : bool|null
$uploadStatus  : 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

FAILURE_REASON_CODEC

Unsupported codec.

public mixed FAILURE_REASON_CODEC = 'codec'

FAILURE_REASON_CONVERSION

Unable to convert video content.

public mixed FAILURE_REASON_CONVERSION = 'conversion'

FAILURE_REASON_EMPTY_FILE

Empty file.

public mixed FAILURE_REASON_EMPTY_FILE = 'emptyFile'

FAILURE_REASON_INVALID_FILE

Invalid file format.

public mixed FAILURE_REASON_INVALID_FILE = 'invalidFile'

FAILURE_REASON_TOO_SMALL

File was too small.

public mixed FAILURE_REASON_TOO_SMALL = 'tooSmall'

FAILURE_REASON_UPLOAD_ABORTED

Upload wasn't finished.

public mixed FAILURE_REASON_UPLOAD_ABORTED = 'uploadAborted'

LICENSE_CREATIVE_COMMON

Creative Commons license.

public mixed LICENSE_CREATIVE_COMMON = 'creativeCommon'

LICENSE_YOUTUBE

Standard YouTube license.

public mixed LICENSE_YOUTUBE = 'youtube'

PRIVACY_STATUS_PRIVATE

A `privacyStatus` of `private`.

public mixed PRIVACY_STATUS_PRIVATE = 'private'

PRIVACY_STATUS_PUBLIC

A `privacyStatus` of `public`.

public mixed PRIVACY_STATUS_PUBLIC = 'public'

PRIVACY_STATUS_UNLISTED

A `privacyStatus` of `unlisted`.

public mixed PRIVACY_STATUS_UNLISTED = 'unlisted'

REJECTION_REASON_CLAIM

Blocked by content owner.

public mixed REJECTION_REASON_CLAIM = 'claim'

Copyright infringement.

public mixed REJECTION_REASON_COPYRIGHT = 'copyright'

REJECTION_REASON_DUPLICATE

Duplicate upload in the same channel.

public mixed REJECTION_REASON_DUPLICATE = 'duplicate'

REJECTION_REASON_INAPPROPRIATE

Inappropriate video content.

public mixed REJECTION_REASON_INAPPROPRIATE = 'inappropriate'

An unspecified legal reason.

public mixed REJECTION_REASON_LEGAL = 'legal'

REJECTION_REASON_LENGTH

Video duration was too long.

public mixed REJECTION_REASON_LENGTH = 'length'

REJECTION_REASON_TERMS_OF_USE

Terms of use violation.

public mixed REJECTION_REASON_TERMS_OF_USE = 'termsOfUse'

REJECTION_REASON_TRADEMARK

Trademark infringement.

public mixed REJECTION_REASON_TRADEMARK = 'trademark'

REJECTION_REASON_UPLOADER_ACCOUNT_CLOSED

Uploader closed his/her account.

public mixed REJECTION_REASON_UPLOADER_ACCOUNT_CLOSED = 'uploaderAccountClosed'

REJECTION_REASON_UPLOADER_ACCOUNT_SUSPENDED

Uploader account was suspended.

public mixed REJECTION_REASON_UPLOADER_ACCOUNT_SUSPENDED = 'uploaderAccountSuspended'

UPLOAD_STATUS_DELETED

Video has been deleted.

public mixed UPLOAD_STATUS_DELETED = 'deleted'

UPLOAD_STATUS_FAILED

Processing has failed. See FailureReason.

public mixed UPLOAD_STATUS_FAILED = 'failed'

UPLOAD_STATUS_PROCESSED

Video has been successfully processed.

public mixed UPLOAD_STATUS_PROCESSED = 'processed'

UPLOAD_STATUS_REJECTED

Video has been rejected. See RejectionReason.

public mixed UPLOAD_STATUS_REJECTED = 'rejected'

UPLOAD_STATUS_UPLOADED

Video has been uploaded but not processed yet.

public mixed UPLOAD_STATUS_UPLOADED = 'uploaded'

Properties

$containsSyntheticMedia

public bool|null $containsSyntheticMedia

Indicates if the video contains altered or synthetic media.

$embeddable

public bool|null $embeddable

This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update

$failureReason

public string|null $failureReason

This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. One of the FAILURE_REASON_* constants.

$license

public string|null $license

The video's license. @mutable youtube.videos.insert youtube.videos.update One of the LICENSE_* constants.

$privacyStatus

public string|null $privacyStatus

The video's privacy status. One of the PRIVACY_STATUS_* constants.

$publicStatsViewable

public bool|null $publicStatsViewable

This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update

$publishAt

public CarbonImmutable|null $publishAt

The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private..

$rejectionReason

public string|null $rejectionReason

This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. One of the REJECTION_REASON_* constants.

$selfDeclaredMadeForKids

public bool|null $selfDeclaredMadeForKids

$uploadStatus

public string|null $uploadStatus

The status of the uploaded video. One of the UPLOAD_STATUS_* constants.

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

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