CISPlayerStateManagerProtocol

@protocol CISPlayerStateManagerProtocol <NSObject>

Helper class to store and relay pertinent video player data to Conviva. Lifecycle is tied to an instance of the video player.
Collects/Reports player’s data to SDK.
The lifecycle of the class conforming to this protocol is managed by application client instance.

  • Returns the latest duration collected by this PlayerStateManager instance.

    Declaration

    Objective-C

    - (NSInteger)getDuration;

    Swift

    optional func getDuration() -> Int

    Return Value

    Latest duration collected. -1 if not available.

  • Deprecated

    Reports the duration of the video stream played by the related video player. If you know the duration of the video stream in advance, consider setting ContentMetadata.duration instead. DO NOT USE DEPRECATED

    Declaration

    Objective-C

    - (void)setDuration:(NSInteger)duration;

    Swift

    optional func setDuration(_ duration: Int)

    Parameters

    duration

    Stream duration.

  • Returns the last player type collected by this PlayerStateManager instance.

    Declaration

    Objective-C

    - (NSString *)getPlayerType;

    Swift

    optional func getPlayerType() -> String!

    Return Value

    Last player type collected. Nil if not available.

  • Reports the type of player monitored via the PlayerInterface instance.

    Declaration

    Objective-C

    - (void)setPlayerType:(NSString *)plType;

    Swift

    optional func setPlayerType(_ plType: String!)

    Parameters

    plType

    Type of the player.

  • Returns the last player framework version collected by this PlayerStateManager instance.

    Declaration

    Objective-C

    - (NSString *)getPlayerVersion;

    Swift

    optional func getPlayerVersion() -> String!

    Return Value

    Last player framework version collected. Nil if not available.

  • Reports the version of the related video player.

    Declaration

    Objective-C

    - (void)setPlayerVersion:(NSString *)plVer;

    Swift

    optional func setPlayerVersion(_ plVer: String!)

    Parameters

    plVer

    A version of the player.

  • Returns the current state of the video player monitored by the PlayerInterface instance.

    Declaration

    Objective-C

    - (PlayerState)getPlayerState;

    Swift

    optional func getPlayerState() -> PlayerState

    Return Value

    The current state of the video player under monitoring.

  • Reports the new player state of the related video player.

    Declaration

    Objective-C

    - (void)setPlayerState:(PlayerState)newState;

    Swift

    optional func setPlayerState(_ newState: PlayerState)

    Parameters

    newState

    New player state for the video player under monitoring.

  • Returns the last bitrate collected from the related video player.

    Declaration

    Objective-C

    - (NSInteger)getBitrateKbps;

    Swift

    optional func getBitrateKbps() -> Int

    Return Value

    The current known bitrate of the video player under monitoring. -1 if not available.

  • Reports the Edge Server CDN IP Address for the video stream played.

    Declaration

    Objective-C

    - (void)setCDNServerIP:(NSString *)cdnServerIP;

    Swift

    optional func setCDNServerIP(_ cdnServerIP: String!)

    Parameters

    cdnServerIP

    CDN server IP address.

  • Reports the new bitrate of the video stream played by the related video player. We recommend reporting manifest/nominal bitrates. For protocols like Smooth Streaming, you may have to sum audio and video bitrates to get the total bitrate.

    Declaration

    Objective-C

    - (void)setBitrateKbps:(NSInteger)newBitrateKbps;

    Swift

    optional func setBitrateKbps(_ newBitrateKbps: Int)

    Parameters

    newBitrateKbps

    New player state for the video player under monitoring.

  • Reports the new average bitrate of the video stream played by the related video player. We recommend reporting manifest/average bitrates. For protocols like Smooth Streaming, you may have to sum audio and video bitrates to get the total bitrate.

    Declaration

    Objective-C

    - (void)setAvgBitrateKbps:(NSInteger)newAvgBitrateKbps;

    Swift

    optional func setAvgBitrateKbps(_ newAvgBitrateKbps: Int)

    Parameters

    newAvgBitrateKbps

    New player state for the video player under monitoring.

  • Reports an error while playing a video stream in the related video player. These include networking errors, download errors, parsing errors, decoding/decrypting errors, DRM errors. For best use, the error message should not include variables like user IDs and memory addresses.

    Declaration

    Objective-C

    - (void)sendError:(NSString *)errMessage errorSeverity:(ErrorSeverity)severity;

    Swift

    optional func sendError(_ errMessage: String!, errorSeverity severity: ErrorSeverity)

    Parameters

    errMessage

    The error message or error code for this error.
    severity

    The severity of this error. See enum in CISConstant.

  • Setter for CISIClientMeasureInterface.

    Declaration

    Objective-C

    - (void)setCISIClientMeasureInterface:
    (id<CISIClientMeasureInterface>)clientMeasureInterface;

    Swift

    optional func setCISIClientMeasureInterface(_ clientMeasureInterface: CISIClientMeasureInterface!)

    Parameters

    clientMeasureInterface

    Instance of clientMeasureInterface protocol implementing class, the player proxy classes will implement CISIClientMeasureInterface.

  • Reports the video resolution width of video stream played by the related video player.

    Declaration

    Objective-C

    - (void)setVideoResolutionWidth:(NSUInteger)videoWidth;

    Swift

    optional func setVideoResolutionWidth(_ videoWidth: UInt)

    Parameters

    videoWidth

    Video resolution width.

  • Reports the video resolution height of video stream played by the related video player.

    Declaration

    Objective-C

    - (void)setVideoResolutionHeight:(NSUInteger)videoHeight;

    Swift

    optional func setVideoResolutionHeight(_ videoHeight: UInt)

    Parameters

    videoHeight

    Video resolution height.

  • Deprecated

    Reports the Edge Server CDN IP Address for the video stream played. DO NOT USE DEPRECATED

    Declaration

    Objective-C

    - (void)setCDNServerIPAddress:(NSString *)cdnServerIP;

    Swift

    optional func setCDNServerIPAddress(_ cdnServerIP: String!)

    Parameters

    cdnServerIP

    CDN server IP address.

  • Reports the signal strength of the connected network.

    Declaration

    Objective-C

    - (void)setSignalStrength:(double)signalStrength;

    Swift

    optional func setSignalStrength(_ signalStrength: Double)

    Parameters

    signalStrength

    Signal strength of the connected network device.

  • Reports the link encryption type of the connected network.

    Declaration

    Objective-C

    - (void)setLinkEncryption:(NSString *)linkEncryptionType;

    Swift

    optional func setLinkEncryption(_ linkEncryptionType: String!)

    Parameters

    linkEncryptionType

    Link encryption type of the network.

  • Reports the connection type of the connected network.

    Declaration

    Objective-C

    - (void)setConnectionType:(NSString *)connectionType;

    Swift

    optional func setConnectionType(_ connectionType: String!)

    Parameters

    connectionType

    Connection type of the network.

  • Reports the player seek start.

    Declaration

    Objective-C

    - (void)setSeekStart:(int64_t)seekToPosition;

    Swift

    optional func setSeekStart(_ seekToPosition: Int64)

    Parameters

    seekToPosition

    Position to seek in milliseconds.

  • Reports the player seek end.

    Declaration

    Objective-C

    - (void)setSeekEnd:(int64_t)seekPosition;

    Swift

    optional func setSeekEnd(_ seekPosition: Int64)

    Parameters

    seekPosition

    Position at end of seek in milliseconds.

  • Reports YES only when setSeekStart() was called.Default Value is NO.

    Declaration

    Objective-C

    - (BOOL)isPlayerSeeking;

    Swift

    optional func isPlayerSeeking() -> Bool

  • Deprecated

    Notify Conviva that the stream Url has changed for the monitoring session. DO NOT USE DEPRECATED

    Declaration

    Objective-C

    - (void)updateStreamUrl:(NSString *)newStreamUrl;

    Swift

    optional func updateStreamUrl(_ newStreamUrl: String!)

    Parameters

    newStreamUrl

    StreamUrl to be updated.

  • Deprecated

    Notify Conviva that the CDN Name has changed for the monitoring session. DO NOT USE DEPRECATED

    Declaration

    Objective-C

    - (void)updateCDNName:(NSString *)newCDNName;

    Swift

    optional func updateCDNName(_ newCDNName: String!)

    Parameters

    newCDNName

    New CDN to be updated.

  • Deprecated

    Notify Conviva that the Resource has changed for the monitoring session. DO NOT USE DEPRECATED

    Declaration

    Objective-C

    - (void)updateResource:(NSString *)newResource;

    Swift

    optional func updateResource(_ newResource: String!)

    Parameters

    newResource

    New Resource to be updated.

  • Deprecated

    Updates ContentMetadata. DO NOT USE DEPRECATED.

    Declaration

    Objective-C

    - (void)updateContentMetadata:(CISContentMetadata *)newcontentInfo;

    Swift

    optional func update(_ newcontentInfo: CISContentMetadata!)

    Parameters

    newcontentInfo

    the new metadata info to be updated.

  • Discard the video quality data contained in this PlayerStateManager instance.

    Declaration

    Objective-C

    - (void)reset;

    Swift

    optional func reset()