CISPlayerEventsListenerProtocol

@protocol CISPlayerEventsListenerProtocol <NSObject>

/// @brief Signal a change in the bitrate, resource or CDN
///
/// \param bitrateKbps New bitrate
/// \param cdn New CDN
/// \param resource New resource
/// \note Use -1 or null to keep previous value
- (void)setStream:(int)bitrateKbps cdn:(nullable NSString *)cdn resource:(nullable NSString *)resource;

/// @brief Signal change in average bitrate
///
/// \param avgbitrateKbps New bitrate
- (void)setAverageBitrate:(int)avgbitrateKbps;


/// @brief Signal change in playing state
///
/// \param newState the new playing state (one of the constants in PlayerStates)
- (void)setPlayingState:(int)newState;

/// @brief Signal an error
///
/// \param err Error Message
//- (void)onError:(ConvivaStreamerError *)err;

- (void)onError:(NSString *)errMsg fatal:(BOOL)fatal;

/// @brief Signal an error
///
/// \param videoWidth Video Width
/// \param videoHeight Video Height
- (void)setVideoDimensionChages:(NSInteger)videoWidth videoHeight:(NSInteger)videoHeight;

/// @brief Signal an player seeking
-(BOOL)isPlayerSeeking;

//-(void)setSeekEvent:(SeekActionType)type seekPosition:(NSInteger)seekToPosition;

-(void)setSeekStart:(NSInteger)seekToPosition;

-(void)setSeekStop:(NSInteger)seekToPosition;

/// @brief sets the module version
///
/// \param moduleVersion module version
-(void)setModuleVersion:(NSString*)moduleVersion;

/// @brief sets the module name
///
/// \param moduleName module version
-(void)setModuleName:(NSString*)moduleName;

/// @brief sets the framework name
///
/// \param fwName module version
-(void)setFrameworkName:(NSString*)fwName;

/// @brief  sets the framework version
///
/// \param fwVersion module version
-(void)setFrameworkVersion:(NSString*)fwVersion;

/// @brief  sets the streamUrl
///
/// \param streamUrl Stream url
-(void)setStreamUrl:(NSString*)streamUrl;

/// @brief  sets the content length
///
/// \param contentLength length
-(void)setContentLength:(NSInteger)contentLength;

/// @brief  sets the cdn ip
///
/// \param cdnIp cdn ip address
-(void)setCdnIp:(NSString*)cdnIp;

/// @brief Sets play head time
///
/// \param pht Play head time
- (void)setPHT:(int64_t)pht;

/// @brief Sets buffer length
///
/// \param bl Buffer length
- (void)setBufferLength:(int64_t)bl;

/// @brief Sets average frame rate
///
/// \param fps Average frame rate.
- (void)setAverageFrameRate:(int)fps;

/// @brief Sets encoded frame rate
///
/// \param fps Encoded frame rate.
- (void)setEncodedFrameRate:(int)fps;

/// @brief Tells whether simplified sdk/legacy sdk api's used.
///
- (BOOL) isSimplifiedSDKApiUsed;
@end

Undocumented

  • @brief Signal a change in the bitrate, resource or CDN

    \param bitrateKbps New bitrate \param cdn New CDN \param resource New resource \note Use -1 or null to keep previous value

    Declaration

    Objective-C

    - (void)setStream:(int)bitrateKbps
                  cdn:(nullable NSString *)cdn
             resource:(nullable NSString *)resource;

    Swift

    func setStream(_ bitrateKbps: Int32, cdn: String?, resource: String?)
  • @brief Signal change in average bitrate

    \param avgbitrateKbps New bitrate

    Declaration

    Objective-C

    - (void)setAverageBitrate:(int)avgbitrateKbps;

    Swift

    func setAverageBitrate(_ avgbitrateKbps: Int32)
  • @brief Signal change in playing state

    \param newState the new playing state (one of the constants in PlayerStates)

    Declaration

    Objective-C

    - (void)setPlayingState:(int)newState;

    Swift

    func setPlayingState(_ newState: Int32)
  • Undocumented

    Declaration

    Objective-C

    - (void)onError:(NSString *)errMsg fatal:(BOOL)fatal;

    Swift

    func onError(_ errMsg: String, fatal: Bool)
  • @brief Signal an error

    \param videoWidth Video Width \param videoHeight Video Height

    Declaration

    Objective-C

    - (void)setVideoDimensionChages:(NSInteger)videoWidth
                        videoHeight:(NSInteger)videoHeight;

    Swift

    func setVideoDimensionChages(_ videoWidth: Int, videoHeight: Int)
  • @brief Signal an player seeking

    Declaration

    Objective-C

    - (BOOL)isPlayerSeeking;

    Swift

    func isPlayerSeeking() -> Bool
  • Undocumented

    Declaration

    Objective-C

    -(void)setSeekStart:(NSInteger)seekToPosition;

    Swift

    func setSeekStart(_ seekToPosition: Int)
  • Undocumented

    Declaration

    Objective-C

    -(void)setSeekStop:(NSInteger)seekToPosition;

    Swift

    func setSeekStop(_ seekToPosition: Int)
  • @brief sets the module version

    \param moduleVersion module version

    Declaration

    Objective-C

    - (void)setModuleVersion:(nonnull NSString *)moduleVersion;

    Swift

    func setModuleVersion(_ moduleVersion: String)
  • @brief sets the module name

    \param moduleName module version

    Declaration

    Objective-C

    - (void)setModuleName:(nonnull NSString *)moduleName;

    Swift

    func setModuleName(_ moduleName: String)
  • @brief sets the framework name

    \param fwName module version

    Declaration

    Objective-C

    - (void)setFrameworkName:(nonnull NSString *)fwName;

    Swift

    func setFrameworkName(_ fwName: String)
  • @brief sets the framework version

    \param fwVersion module version

    Declaration

    Objective-C

    - (void)setFrameworkVersion:(nonnull NSString *)fwVersion;

    Swift

    func setFrameworkVersion(_ fwVersion: String)
  • @brief sets the streamUrl

    \param streamUrl Stream url

    Declaration

    Objective-C

    - (void)setStreamUrl:(nonnull NSString *)streamUrl;

    Swift

    func setStreamUrl(_ streamUrl: String)
  • @brief sets the content length

    \param contentLength length

    Declaration

    Objective-C

    - (void)setContentLength:(NSInteger)contentLength;

    Swift

    func setContentLength(_ contentLength: Int)
  • @brief sets the cdn ip

    \param cdnIp cdn ip address

    Declaration

    Objective-C

    - (void)setCdnIp:(nonnull NSString *)cdnIp;

    Swift

    func setCdnIp(_ cdnIp: String)
  • @brief Sets play head time

    \param pht Play head time

    Declaration

    Objective-C

    - (void)setPHT:(int64_t)pht;

    Swift

    func setPHT(_ pht: Int64)
  • @brief Sets buffer length

    \param bl Buffer length

    Declaration

    Objective-C

    - (void)setBufferLength:(int64_t)bl;

    Swift

    func setBufferLength(_ bl: Int64)
  • @brief Sets average frame rate

    \param fps Average frame rate.

    Declaration

    Objective-C

    - (void)setAverageFrameRate:(int)fps;

    Swift

    func setAverageFrameRate(_ fps: Int32)
  • @brief Sets encoded frame rate

    \param fps Encoded frame rate.

    Declaration

    Objective-C

    - (void)setEncodedFrameRate:(int)fps;

    Swift

    func setEncodedFrameRate(_ fps: Int32)
  • @brief Tells whether simplified sdk/legacy sdk api’s used.

    Declaration

    Objective-C

    - (BOOL)isSimplifiedSDKApiUsed;

    Swift

    func isSimplifiedSDKApiUsed() -> Bool