ImageSettings
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.
Branding properties for images associated with the channel.
Tags
Table of Contents
Properties
- $backgroundImageUrl : LocalizedProperty|null
- $bannerExternalUrl : string|null
- $bannerImageUrl : string|null
- $bannerMobileExtraHdImageUrl : string|null
- $bannerMobileHdImageUrl : string|null
- $bannerMobileImageUrl : string|null
- $bannerMobileLowImageUrl : string|null
- $bannerMobileMediumHdImageUrl : string|null
- $bannerTabletExtraHdImageUrl : string|null
- $bannerTabletHdImageUrl : string|null
- $bannerTabletImageUrl : string|null
- $bannerTabletLowImageUrl : string|null
- $bannerTvHighImageUrl : string|null
- $bannerTvImageUrl : string|null
- $bannerTvLowImageUrl : string|null
- $bannerTvMediumImageUrl : string|null
- $largeBrandedBannerImageImapScript : LocalizedProperty|null
- $largeBrandedBannerImageUrl : LocalizedProperty|null
- $smallBrandedBannerImageImapScript : LocalizedProperty|null
- $smallBrandedBannerImageUrl : LocalizedProperty|null
- $trackingImageUrl : string|null
- $watchIconImageUrl : 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()}.
Properties
$backgroundImageUrl
public
LocalizedProperty|null
$backgroundImageUrl
Deprecated. The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
$bannerExternalUrl
public
string|null
$bannerExternalUrl
This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
$bannerImageUrl
public
string|null
$bannerImageUrl
Deprecated. Banner image. Desktop size (1060x175).
$bannerMobileExtraHdImageUrl
public
string|null
$bannerMobileExtraHdImageUrl
Deprecated. Banner image. Mobile size high resolution (1440x395).
$bannerMobileHdImageUrl
public
string|null
$bannerMobileHdImageUrl
Deprecated. Banner image. Mobile size high resolution (1280x360).
$bannerMobileImageUrl
public
string|null
$bannerMobileImageUrl
Deprecated. Banner image. Mobile size (640x175).
$bannerMobileLowImageUrl
public
string|null
$bannerMobileLowImageUrl
Deprecated. Banner image. Mobile size low resolution (320x88).
$bannerMobileMediumHdImageUrl
public
string|null
$bannerMobileMediumHdImageUrl
Deprecated. Banner image. Mobile size medium/high resolution (960x263).
$bannerTabletExtraHdImageUrl
public
string|null
$bannerTabletExtraHdImageUrl
Deprecated. Banner image. Tablet size extra high resolution (2560x424).
$bannerTabletHdImageUrl
public
string|null
$bannerTabletHdImageUrl
Deprecated. Banner image. Tablet size high resolution (2276x377).
$bannerTabletImageUrl
public
string|null
$bannerTabletImageUrl
Deprecated. Banner image. Tablet size (1707x283).
$bannerTabletLowImageUrl
public
string|null
$bannerTabletLowImageUrl
Deprecated. Banner image. Tablet size low resolution (1138x188).
$bannerTvHighImageUrl
public
string|null
$bannerTvHighImageUrl
Deprecated. Banner image. TV size high resolution (1920x1080).
$bannerTvImageUrl
public
string|null
$bannerTvImageUrl
Deprecated. Banner image. TV size extra high resolution (2120x1192).
$bannerTvLowImageUrl
public
string|null
$bannerTvLowImageUrl
Deprecated. Banner image. TV size low resolution (854x480).
$bannerTvMediumImageUrl
public
string|null
$bannerTvMediumImageUrl
Deprecated. Banner image. TV size medium resolution (1280x720).
$largeBrandedBannerImageImapScript
public
LocalizedProperty|null
$largeBrandedBannerImageImapScript
Deprecated. The image map script for the large banner image.
$largeBrandedBannerImageUrl
public
LocalizedProperty|null
$largeBrandedBannerImageUrl
Deprecated. The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
$smallBrandedBannerImageImapScript
public
LocalizedProperty|null
$smallBrandedBannerImageImapScript
Deprecated. The image map script for the small banner image.
$smallBrandedBannerImageUrl
public
LocalizedProperty|null
$smallBrandedBannerImageUrl
Deprecated. The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
$trackingImageUrl
public
string|null
$trackingImageUrl
Deprecated. The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
$watchIconImageUrl
public
string|null
$watchIconImageUrl
Deprecated.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= ['backgroundImageUrl' => 'LocalizedProperty', 'largeBrandedBannerImageImapScript' => 'LocalizedProperty', 'largeBrandedBannerImageUrl' => 'LocalizedProperty', 'smallBrandedBannerImageImapScript' => 'LocalizedProperty', 'smallBrandedBannerImageUrl' => 'LocalizedProperty']
$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