BitmovinApiSdk\Models\AnalyticsImpressionSample
Synopsis
class AnalyticsImpressionSample
extends ApiResource
{
- // members
- public int $ad;
- public string $analyticsVersion;
- public int $audioBitrate;
- public string $audioCodec;
- public string $audioLanguage;
- public bool $autoplay;
- public string $browser;
- public string $browserVersionMajor;
- public string $browserVersionMinor;
- public int $buffered;
- public string $cdnProvider;
- public string $castTech;
- public string $city;
- public int $clientTime;
- public string $country;
- public string $customUserId;
- public string $customData1;
- public string $customData2;
- public string $customData3;
- public string $customData4;
- public string $customData5;
- public string $customData6;
- public string $customData7;
- public string $customData8;
- public string $customData9;
- public string $customData10;
- public string $customData11;
- public string $customData12;
- public string $customData13;
- public string $customData14;
- public string $customData15;
- public string $customData16;
- public string $customData17;
- public string $customData18;
- public string $customData19;
- public string $customData20;
- public string $customData21;
- public string $customData22;
- public string $customData23;
- public string $customData24;
- public string $customData25;
- public string $customData26;
- public string $customData27;
- public string $customData28;
- public string $customData29;
- public string $customData30;
- public string $deviceClass;
- public string $deviceType;
- public string $domain;
- public int $drmLoadTime;
- public string $drmType;
- public int $droppedFrames;
- public int $duration;
- public int $errorCode;
- public string $errorMessage;
- public string $experimentName;
- public string $impressionId;
- public string $ipAddress;
- public bool $isCasting;
- public bool $isLive;
- public bool $isMuted;
- public string $isp;
- public string $language;
- public string $licenseKey;
- public string $m3u8Url;
- public string $mpdUrl;
- public string $operatingsystem;
- public string $operatingsystemVersionMajor;
- public string $operatingsystemVersionMinor;
- public int $pageLoadTime;
- public int $pageLoadType;
- public string $path;
- public int $paused;
- public string $platform;
- public int $played;
- public string $player;
- public string $playerKey;
- public int $playerStartuptime;
- public string $playerTech;
- public string $playerVersion;
- public string $progUrl;
- public string $region;
- public int $screenHeight;
- public int $screenWidth;
- public string $screenOrientation;
- public int $seeked;
- public int $segmentDownloadCount;
- public int $segmentDownloadSize;
- public int $segmentDownloadTime;
- public int $sequenceNumber;
- public string $size;
- public int $startuptime;
- public string $state;
- public string $streamFormat;
- public bool $subtitleEnabled;
- public string $subtitleLanguage;
- public array $supportedVideoCodes;
- public int $time;
- public string $userId;
- public int $videoBitrate;
- public string $videoCodec;
- public int $videoDuration;
- public string $videoId;
- public string $videoTitle;
- public int $videoPlaybackHeight;
- public int $videoPlaybackWidth;
- public int $videoStartuptime;
- public int $videotimeEnd;
- public int $videotimeStart;
- public int $videoWindowHeight;
- public int $videoWindowWidth;
- public bool $videostartFailed;
- public AnalyticsVideoStartFailedReason $videostartFailedReason;
- // methods
- public void __construct()
- public $this ad()
- public $this analyticsVersion()
- public $this audioBitrate()
- public $this audioCodec()
- public $this audioLanguage()
- public $this autoplay()
- public $this browser()
- public $this browserVersionMajor()
- public $this browserVersionMinor()
- public $this buffered()
- public $this cdnProvider()
- public $this castTech()
- public $this city()
- public $this clientTime()
- public $this country()
- public $this customUserId()
- public $this customData1()
- public $this customData2()
- public $this customData3()
- public $this customData4()
- public $this customData5()
- public $this customData6()
- public $this customData7()
- public $this customData8()
- public $this customData9()
- public $this customData10()
- public $this customData11()
- public $this customData12()
- public $this customData13()
- public $this customData14()
- public $this customData15()
- public $this customData16()
- public $this customData17()
- public $this customData18()
- public $this customData19()
- public $this customData20()
- public $this customData21()
- public $this customData22()
- public $this customData23()
- public $this customData24()
- public $this customData25()
- public $this customData26()
- public $this customData27()
- public $this customData28()
- public $this customData29()
- public $this customData30()
- public $this deviceClass()
- public $this deviceType()
- public $this domain()
- public $this drmLoadTime()
- public $this drmType()
- public $this droppedFrames()
- public $this duration()
- public $this errorCode()
- public $this errorMessage()
- public $this experimentName()
- public $this impressionId()
- public $this ipAddress()
- public $this isCasting()
- public $this isLive()
- public $this isMuted()
- public $this isp()
- public $this language()
- public $this licenseKey()
- public $this m3u8Url()
- public $this mpdUrl()
- public $this operatingsystem()
- public $this operatingsystemVersionMajor()
- public $this operatingsystemVersionMinor()
- public $this pageLoadTime()
- public $this pageLoadType()
- public $this path()
- public $this paused()
- public $this platform()
- public $this played()
- public $this player()
- public $this playerKey()
- public $this playerStartuptime()
- public $this playerTech()
- public $this playerVersion()
- public $this progUrl()
- public $this region()
- public $this screenHeight()
- public $this screenWidth()
- public $this screenOrientation()
- public $this seeked()
- public $this segmentDownloadCount()
- public $this segmentDownloadSize()
- public $this segmentDownloadTime()
- public $this sequenceNumber()
- public $this size()
- public $this startuptime()
- public $this state()
- public $this streamFormat()
- public $this subtitleEnabled()
- public $this subtitleLanguage()
- public $this supportedVideoCodes()
- public $this time()
- public $this userId()
- public $this videoBitrate()
- public $this videoCodec()
- public $this videoDuration()
- public $this videoId()
- public $this videoTitle()
- public $this videoPlaybackHeight()
- public $this videoPlaybackWidth()
- public $this videoStartuptime()
- public $this videotimeEnd()
- public $this videotimeStart()
- public $this videoWindowHeight()
- public $this videoWindowWidth()
- public $this videostartFailed()
- public $this videostartFailedReason()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Members
public
- $ad — int
- $analyticsVersion — string
- $audioBitrate — int
- $audioCodec — string
- $audioLanguage — string
- $autoplay — BitmovinApiSdk\Models\bool
- $browser — string
- $browserVersionMajor — string
- $browserVersionMinor — string
- $buffered — int
- $castTech — string
- $cdnProvider — string
- $city — string
- $clientTime — int
- $country — string
- $customData1 — string
- $customData10 — string
- $customData11 — string
- $customData12 — string
- $customData13 — string
- $customData14 — string
- $customData15 — string
- $customData16 — string
- $customData17 — string
- $customData18 — string
- $customData19 — string
- $customData2 — string
- $customData20 — string
- $customData21 — string
- $customData22 — string
- $customData23 — string
- $customData24 — string
- $customData25 — string
- $customData26 — string
- $customData27 — string
- $customData28 — string
- $customData29 — string
- $customData3 — string
- $customData30 — string
- $customData4 — string
- $customData5 — string
- $customData6 — string
- $customData7 — string
- $customData8 — string
- $customData9 — string
- $customUserId — string
- $deviceClass — string
- $deviceType — string
- $domain — string
- $drmLoadTime — int
- $drmType — string
- $droppedFrames — int
- $duration — int
- $errorCode — int
- $errorMessage — string
- $experimentName — string
- $impressionId — string
- $ipAddress — string
- $isCasting — BitmovinApiSdk\Models\bool
- $isLive — BitmovinApiSdk\Models\bool
- $isMuted — BitmovinApiSdk\Models\bool
- $isp — string
- $language — string
- $licenseKey — string
- $m3u8Url — string
- $mpdUrl — string
- $operatingsystem — string
- $operatingsystemVersionMajor — string
- $operatingsystemVersionMinor — string
- $pageLoadTime — int
- $pageLoadType — int
- $path — string
- $paused — int
- $platform — string
- $played — int
- $player — string
- $playerKey — string
- $playerStartuptime — int
- $playerTech — string
- $playerVersion — string
- $progUrl — string
- $region — string
- $screenHeight — int
- $screenOrientation — string
- $screenWidth — int
- $seeked — int
- $segmentDownloadCount — int
- $segmentDownloadSize — int
- $segmentDownloadTime — int
- $sequenceNumber — int
- $size — string
- $startuptime — int
- $state — string
- $streamFormat — string
- $subtitleEnabled — BitmovinApiSdk\Models\bool
- $subtitleLanguage — string
- $supportedVideoCodes — BitmovinApiSdk\Models\string[]
- $time — int
- $userId — string
- $videoBitrate — int
- $videoCodec — string
- $videoDuration — int
- $videoId — string
- $videoPlaybackHeight — int
- $videoPlaybackWidth — int
- $videoStartuptime — int
- $videoTitle — string
- $videoWindowHeight — int
- $videoWindowWidth — int
- $videostartFailed — BitmovinApiSdk\Models\bool
- $videostartFailedReason — BitmovinApiSdk\Models\AnalyticsVideoStartFailedReason
- $videotimeEnd — int
- $videotimeStart — int
Methods
public
- __construct()
- ad() — Is an ad playing. 0 indicates no, 1 indicates yes
- analyticsVersion() — Collector version
- audioBitrate() — Audio Bitrate
- audioCodec() — Audio codec of currently playing stream
- audioLanguage() — Selected audio language
- autoplay() — Autoplay enabled
- browser() — Browser name
- browserVersionMajor() — Browser version major
- browserVersionMinor() — Browser version minor
- buffered() — Milliseconds the player buffered
- castTech() — Casting Technology
- cdnProvider() — CDN Provider
- city() — City
- clientTime() — Current time of the client
- country() — Country
- customData1() — Free form data set via the customData1 field in the analytics collector configuration
- customData10() — Free form data set via the customData10 field in the analytics collector configuration
- customData11() — Free form data set via the customData11 field in the analytics collector configuration
- customData12() — Free form data set via the customData12 field in the analytics collector configuration
- customData13() — Free form data set via the customData13 field in the analytics collector configuration
- customData14() — Free form data set via the customData14 field in the analytics collector configuration
- customData15() — Free form data set via the customData15 field in the analytics collector configuration
- customData16() — Free form data set via the customData16 field in the analytics collector configuration
- customData17() — Free form data set via the customData17 field in the analytics collector configuration
- customData18() — Free form data set via the customData18 field in the analytics collector configuration
- customData19() — Free form data set via the customData19 field in the analytics collector configuration
- customData2() — Free form data set via the customData2 field in the analytics collector configuration
- customData20() — Free form data set via the customData20 field in the analytics collector configuration
- customData21() — Free form data set via the customData21 field in the analytics collector configuration
- customData22() — Free form data set via the customData22 field in the analytics collector configuration
- customData23() — Free form data set via the customData23 field in the analytics collector configuration
- customData24() — Free form data set via the customData24 field in the analytics collector configuration
- customData25() — Free form data set via the customData25 field in the analytics collector configuration
- customData26() — Free form data set via the customData26 field in the analytics collector configuration
- customData27() — Free form data set via the customData27 field in the analytics collector configuration
- customData28() — Free form data set via the customData28 field in the analytics collector configuration
- customData29() — Free form data set via the customData29 field in the analytics collector configuration
- customData3() — Free form data set via the customData3 field in the analytics collector configuration
- customData30() — Free form data set via the customData30 field in the analytics collector configuration
- customData4() — Free form data set via the customData4 field in the analytics collector configuration
- customData5() — Free form data set via the customData5 field in the analytics collector configuration
- customData6() — Free form data set via the customData6 field in the analytics collector configuration
- customData7() — Free form data set via the customData7 field in the analytics collector configuration
- customData8() — Free form data set via the customData8 field in the analytics collector configuration
- customData9() — Free form data set via the customData9 field in the analytics collector configuration
- customUserId() — Custom user ID
- deviceClass() — Type of device (Desktop, Phone, Tablet)
- deviceType() — Type of the device detected via User Agent
- domain() — Domain the player was loaded on (.www is stripped away)
- drmLoadTime() — Time in milliseconds it took the DRM server to respond
- drmType() — DRM system used for this impression
- droppedFrames() — Dropped frames during playback
- duration() — Duration of the sample in milliseconds
- errorCode() — Error code
- errorMessage() — Error message
- experimentName() — A/B test experiment name
- impressionId() — Random UUID that is used to identify a session (required)
- ipAddress() — IP Address of the client
- isCasting() — Is chromecast active
- isLive() — Is the stream live or VoD
- isMuted() — Is the player muted
- isp() — The users Internet Service Provider inferred via the IP address
- language() — Language set in the browser
- licenseKey() — Analytics license key
- m3u8Url() — URL of the HLS source
- mpdUrl() — URL of the DASH source
- operatingsystem() — Operating system
- operatingsystemVersionMajor() — Operating system version major
- operatingsystemVersionMinor() — Operating system version minor
- pageLoadTime() — Time in milliseconds the page took to load
- pageLoadType() — Player load type. 1 = Foreground, 2 = Background
- path() — path on the website
- paused() — Milliseconds the player was paused
- platform() — Platform the player is running on (web, android, ios)
- played() — Milliseconds the player played
- player() — Video player being used for this session
- playerKey() — Player license key
- playerStartuptime() — Time in milliseconds the player took to start up
- playerTech() — HTML or native playback
- playerVersion() — Player software version
- progUrl() — URL of the progressive MP4 source
- region() — Geographic region (ISO 3166-2 code)
- screenHeight() — Screen as reported by the browser
- screenOrientation() — Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)
- screenWidth() — Screen as reported by the browser
- seeked() — Milliseconds it took the player to seek
- segmentDownloadCount() — Number of video segments downloaded
- segmentDownloadSize() — Size of downloaded video segments (byte)
- segmentDownloadTime() — Cumulative time needed to download video segments
- sequenceNumber() — Sequence number of the sample in which it occurred in the session
- size() — Video size (FULLSCREEN or WINDOW)
- startuptime() — Combination of player- and videoStartuptime
- state() — Internal state of the analytics state machine
- streamFormat() — Format of the stream (HLS, DASH, Progressive MP4)
- subtitleEnabled() — Subtitle enabled
- subtitleLanguage() — Selected subtitle language
- supportedVideoCodes() — Video codecs supported by platform/browser
- time() — Current time in milliseconds
- userId() — ID that is persisted across sessions to identify a browser
- videoBitrate() — Bitrate of the played back video rendition
- videoCodec() — Video codec of current stream
- videoDuration() — Length of the video in milliseconds
- videoId() — ID of the video as configured via the analytics config
- videoPlaybackHeight() — Resolution of the played back Video Rendition
- videoPlaybackWidth() — Resolution of the played back Video Rendition
- videoStartuptime() — Time in milliseconds it took to start video playback
- videoTitle() — Free form human readable video title as configured in the analytics config
- videoWindowHeight() — Height of the video player on the page
- videoWindowWidth() — Width of the video player on the page
- videostartFailed() — True if starting the video failed
- videostartFailedReason() — Reason why starting the video failed
- videotimeEnd() — End time of the sample in the video (milliseconds)
- videotimeStart() — Start time of the sample in the video (milliseconds)