ConvivaLightSession

@interface ConvivaLightSession : NSObject

/// @brief Cleanup session. Should be called when a video session is over.
///
/// Releases the reference to monitored streamer. Session can be safely released
/// after this call
- (void)cleanup;

/// Send an custom event pertaining to the session
- (void)sendEvent:(NSString *)name withAttributes:(NSDictionary *)attributes;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)setContentLength:(NSInteger)contentLength DEPRECATED_ATTRIBUTE;

/// Notify that ad has started
- (void)adStart;

/// Notify that ad has started with type of ad stream and player type etc.
- (void)adStart:(AdStream)adStream adPlayer:(AdPlayer)adPlayer adPosition:(AdPosition)adPosition;

/// Notify that ad has ended
- (void)adEnd;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)setCdnNameOrResource:(NSString *)cdnNameOrResource DEPRECATED_ATTRIBUTE;

/// Report a fatal error and use specified error message
- (void)reportError:(NSString *)errorMsg DEPRECATED_ATTRIBUTE;

/// Report a fatal and non fatal error and use specified error message
- (void)reportError:(NSString *)errorMessage errorType:(ErrorSeverity)severity;

/// Attach streamer to specified streamer */
- (void)attachStreamer:(id)streamer;

/// @brief Pause session monitoring such that it can be resumed later
/// @note The existing streamer is detached from the session.
/// @see attachStreamer()
- (void)pauseMonitor;

/// @brief Set the current bitrate
- (void)setBitrate:(int)bitrateKbps;

/// @brief Set the CDN Server IP
- (void)setCDNServerIP:(NSString *)cdnServerIP;

/// @brief Set the Link Encryption
- (void)setLinkEncryption:(NSString*)newLinkEncryption;

/// @brief Set the Signal Strength
- (void)setSignalStrength:(double)newSignalStrength;

/// @brief Set the Connection Type
- (void)setConnectionType:(NSString *)newConnectionType;

/// @brief Set Player seek Start
- (void)setSeekStart:(NSInteger)seekToPosition;

/// @brief Set Player seek End
- (void)setSeekEnd:(NSInteger)seekPosition;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)updateStreamUrl:(NSString *)newStreamUrl DEPRECATED_ATTRIBUTE;

/// @brief update content metadata
- (void)updateContentMetadata:(ConvivaContentInfo *)newcontentInfo;

/** Reserved method. Do not use. */
- (int) currentSessionType;

- (int)sessionID;

@end

Undocumented

  • @brief Cleanup session. Should be called when a video session is over.

    Releases the reference to monitored streamer. Session can be safely released after this call

    Declaration

    Objective-C

    - (void)cleanup;

    Swift

    func cleanup()

  • Send an custom event pertaining to the session

    Declaration

    Objective-C

    - (void)sendEvent:(NSString *)name withAttributes:(NSDictionary *)attributes;

    Swift

    func sendEvent(_ name: String!, withAttributes attributes: [AnyHashable : Any]! = [:])

  • Deprecated

    This API is depecated use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo

    Declaration

    Objective-C

    - (void)setContentLength:(NSInteger)contentLength;

    Swift

    func setContentLength(_ contentLength: Int)

  • Notify that ad has started

    Declaration

    Objective-C

    - (void)adStart;

    Swift

    func adStart()

  • Notify that ad has started with type of ad stream and player type etc.

    Declaration

    Objective-C

    - (void)adStart:(AdStream)adStream
       adPlayer:(AdPlayer)adPlayer
     adPosition:(AdPosition)adPosition;

    Swift

    func adStart(_ adStream: AdStream, adPlayer: AdPlayer, adPosition: AdPosition)

  • Notify that ad has ended

    Declaration

    Objective-C

    - (void)adEnd;

    Swift

    func adEnd()

  • Deprecated

    This API is depecated use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo

    Declaration

    Objective-C

    - (void)setCdnNameOrResource:(NSString *)cdnNameOrResource;

    Swift

    func setCdnNameOrResource(_ cdnNameOrResource: String!)

  • Deprecated

    Report a fatal error and use specified error message

    Declaration

    Objective-C

    - (void)reportError:(NSString *)errorMsg;

    Swift

    func reportError(_ errorMsg: String!)

  • Report a fatal and non fatal error and use specified error message

    Declaration

    Objective-C

    - (void)reportError:(NSString *)errorMessage errorType:(ErrorSeverity)severity;

    Swift

    func reportError(_ errorMessage: String!, errorType severity: ErrorSeverity)

  • Attach streamer to specified streamer */

    Declaration

    Objective-C

    - (void)attachStreamer:(id)streamer;

    Swift

    func attachStreamer(_ streamer: Any!)

  • @brief Pause session monitoring such that it can be resumed later

    Note

    The existing streamer is detached from the session.

    See

    attachStreamer()

    Declaration

    Objective-C

    - (void)pauseMonitor;

    Swift

    func pauseMonitor()

  • @brief Set the current bitrate

    Declaration

    Objective-C

    - (void)setBitrate:(int)bitrateKbps;

    Swift

    func setBitrate(_ bitrateKbps: Int32)

  • @brief Set the CDN Server IP

    Declaration

    Objective-C

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

    Swift

    func setCDNServerIP(_ cdnServerIP: String!)

  • @brief Set the Link Encryption

    Declaration

    Objective-C

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

    Swift

    func setLinkEncryption(_ newLinkEncryption: String!)

  • @brief Set the Signal Strength

    Declaration

    Objective-C

    - (void)setSignalStrength:(double)newSignalStrength;

    Swift

    func setSignalStrength(_ newSignalStrength: Double)

  • @brief Set the Connection Type

    Declaration

    Objective-C

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

    Swift

    func setConnectionType(_ newConnectionType: String!)

  • @brief Set Player seek Start

    Declaration

    Objective-C

    - (void)setSeekStart:(NSInteger)seekToPosition;

    Swift

    func setSeekStart(_ seekToPosition: Int)

  • @brief Set Player seek End

    Declaration

    Objective-C

    - (void)setSeekEnd:(NSInteger)seekPosition;

    Swift

    func setSeekEnd(_ seekPosition: Int)

  • Deprecated

    This API is depecated use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo

    Declaration

    Objective-C

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

    Swift

    func updateStreamUrl(_ newStreamUrl: String!)

  • @brief update content metadata

    Declaration

    Objective-C

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

    Swift

    func updateContentMetadata(_ newcontentInfo: ConvivaContentInfo!)

  • Reserved method. Do not use.

    Declaration

    Objective-C

    - (int)currentSessionType;

    Swift

    func currentSessionType() -> Int32

  • Undocumented

    Declaration

    Objective-C

    - (int)sessionID;

    Swift

    func sessionID() -> Int32

  • @brief Set the ad player state

    Declaration

    Objective-C

    - (void)setAdPlayerState:(ConvivaAdPlayerState)playerState;

    Swift

    func setAdPlayerState(_ playerState: ConvivaAdPlayerState)

  • @brief Set the ad player name

    Declaration

    Objective-C

    - (void)setAdPlayerName:(NSString *)playerName;

    Swift

    func setAdPlayerName(_ playerName: String!)

  • @brief Set the ad player version

    Declaration

    Objective-C

    - (void)setAdPlayerVersion:(NSString *)playerVersion;

    Swift

    func setAdPlayerVersion(_ playerVersion: String!)

  • @brief Set the ad player width & height

    Declaration

    Objective-C

    - (void)setAdVideoResolutionWidth:(NSInteger)width andHeight:(NSInteger)height;

    Swift

    func setAdVideoResolutionWidth(_ width: Int, andHeight height: Int)

  • @brief Set the current ad player instance buffer length in milliseconds

    Declaration

    Objective-C

    - (void)setAdPlayHeadTime:(NSInteger)pht;

    Swift

    func setAdPlayHeadTime(_ pht: Int)

  • @brief Set the current ad player instance buffer length in milliseconds

    Declaration

    Objective-C

    - (void)setAdBufferLength:(NSInteger)bufferLength;

    Swift

    func setAdBufferLength(_ bufferLength: Int)