VideoProcessingDetails
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.
Describes processing status and progress and availability of some other Video resource parts.
Tags
Table of Contents
Constants
- PROCESSING_FAILURE_REASON_OTHER : mixed = 'other'
- A `processingFailureReason` of `other`.
- PROCESSING_FAILURE_REASON_STREAMING_FAILED : mixed = 'streamingFailed'
- A `processingFailureReason` of `streamingFailed`.
- PROCESSING_FAILURE_REASON_TRANSCODE_FAILED : mixed = 'transcodeFailed'
- A `processingFailureReason` of `transcodeFailed`.
- PROCESSING_FAILURE_REASON_UPLOAD_FAILED : mixed = 'uploadFailed'
- A `processingFailureReason` of `uploadFailed`.
- PROCESSING_STATUS_FAILED : mixed = 'failed'
- A `processingStatus` of `failed`.
- PROCESSING_STATUS_PROCESSING : mixed = 'processing'
- A `processingStatus` of `processing`.
- PROCESSING_STATUS_SUCCEEDED : mixed = 'succeeded'
- A `processingStatus` of `succeeded`.
- PROCESSING_STATUS_TERMINATED : mixed = 'terminated'
- A `processingStatus` of `terminated`.
Properties
- $editorSuggestionsAvailability : string|null
- $fileDetailsAvailability : string|null
- $processingFailureReason : string|null
- $processingIssuesAvailability : string|null
- $processingProgress : VideoProcessingDetailsProcessingProgress|null
- $processingStatus : string|null
- $tagSuggestionsAvailability : string|null
- $thumbnailsAvailability : 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
PROCESSING_FAILURE_REASON_OTHER
A `processingFailureReason` of `other`.
public
mixed
PROCESSING_FAILURE_REASON_OTHER
= 'other'
PROCESSING_FAILURE_REASON_STREAMING_FAILED
A `processingFailureReason` of `streamingFailed`.
public
mixed
PROCESSING_FAILURE_REASON_STREAMING_FAILED
= 'streamingFailed'
PROCESSING_FAILURE_REASON_TRANSCODE_FAILED
A `processingFailureReason` of `transcodeFailed`.
public
mixed
PROCESSING_FAILURE_REASON_TRANSCODE_FAILED
= 'transcodeFailed'
PROCESSING_FAILURE_REASON_UPLOAD_FAILED
A `processingFailureReason` of `uploadFailed`.
public
mixed
PROCESSING_FAILURE_REASON_UPLOAD_FAILED
= 'uploadFailed'
PROCESSING_STATUS_FAILED
A `processingStatus` of `failed`.
public
mixed
PROCESSING_STATUS_FAILED
= 'failed'
PROCESSING_STATUS_PROCESSING
A `processingStatus` of `processing`.
public
mixed
PROCESSING_STATUS_PROCESSING
= 'processing'
PROCESSING_STATUS_SUCCEEDED
A `processingStatus` of `succeeded`.
public
mixed
PROCESSING_STATUS_SUCCEEDED
= 'succeeded'
PROCESSING_STATUS_TERMINATED
A `processingStatus` of `terminated`.
public
mixed
PROCESSING_STATUS_TERMINATED
= 'terminated'
Properties
$editorSuggestionsAvailability
public
string|null
$editorSuggestionsAvailability
This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
$fileDetailsAvailability
public
string|null
$fileDetailsAvailability
This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
$processingFailureReason
public
string|null
$processingFailureReason
The reason that YouTube failed to process the video. This
property will only have a value if the processingStatus property's value is failed. One of the
PROCESSING_FAILURE_REASON_* constants.
$processingIssuesAvailability
public
string|null
$processingIssuesAvailability
This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
$processingProgress
public
VideoProcessingDetailsProcessingProgress|null
$processingProgress
The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
$processingStatus
public
string|null
$processingStatus
The video's processing status. This value indicates whether YouTube
was able to process the video or if the video is still being processed. One of the PROCESSING_STATUS_*
constants.
$tagSuggestionsAvailability
public
string|null
$tagSuggestionsAvailability
This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
$thumbnailsAvailability
public
string|null
$thumbnailsAvailability
This value indicates whether thumbnail images have been generated for the video.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= ['processingProgress' => 'VideoProcessingDetailsProcessingProgress']
$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