Constants

The following constants are available globally.

  • vpkErrorNotification

    Undocumented

    Declaration

    Objective-C

    extern NSString* const vpkErrorNotification
  • vpkErrorKey

    Undocumented

    Declaration

    Objective-C

    extern NSString* const vpkErrorKey
  • vpkPresentErrorKey

    Undocumented

    Declaration

    Objective-C

    extern NSString* const vpkPresentErrorKey

Names for VPKEvent NSNotifications
  • VPKEventVideoLoad

    NSNotification sent when a video is loaded and ready to play

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoLoad
  • VPKEventVideoUnload

    NSNotification sent when a video is unloaded from the video player (no longer the currentItem)

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoUnload
  • VPKEventVideoPlayRequested

    NSNotification sent when the user first requests the video to play (for example, by pressing the play button). This notification is only sent once per video load (not resent after a video pause event).

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoPlayRequested
  • VPKEventVideoPlay

    NSNotification sent when the video currentItem rate changes from 0 to any number greater than 0.

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoPlay
  • VPKEventVideoPause

    NSNotification sent when the video currentItem rate changes from any number greater than 0 to 0

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoPause
  • VPKEventVideoComplete

    NSNotification sent when the video currentItem plays out to the end.

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoComplete
  • VPKEventVideoSeekStart

    NSNotification sent when a seek event is initiated on the player

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoSeekStart
  • VPKEventVideoSeekComplete

    NSNotification sent when a seek event is completed on the player

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoSeekComplete

Quality of Service dictionary keys
  • VPKEventVideoObservedBitrateKey

    The download (network) bitrate in bits per second. Negative if unknown. Value: NSNumber (double)

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoObservedBitrateKey
  • VPKEventVideoPlaybackBitrateKey

    The required bitrate for video playback in bits per second. Negative if unknown. If the network bitrate is less than the playback bitrate, buffering will occur. Value: NSNumber (float)

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoPlaybackBitrateKey
  • VPKEventVideoFramesPerSecondKey

    The video track nominalFrameRate if available: otherwise negative.

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoFramesPerSecondKey
  • VPKEventVideoNumberOfDroppedVideoFrames

    The total number of dropped video frames. Negative if unknown. Value: NSNumber (NSInteger)

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoNumberOfDroppedVideoFrames
  • VPKEventVideoStartupTimeKey

    The accumulated duration until player item is ready to play. Measured in seconds. Negative if unknown. Value: NSNumber (NSTimeInterval)

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoStartupTimeKey
  • VPKEventVideoPlaybackTypeKey

    Media playback type (“LIVE”, “VOD”, “FILE”,“unknown”). Value: NSString

    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKEventVideoPlaybackTypeKey
  • VPKIdentifierKey

    Key to retrieve media identifier from VPKit Video NSNotification event info dictionary.

    See

    VPKImage.mediaIdentifier
    Declaration

    Objective-C

    extern NSString *const _Nonnull VPKIdentifierKey