ccl_notifier_t Struct Reference

ccl_notifier_t is used to push video playback data notifications to the Conviva library. More...

#include <ccl_notifier_if.h>

Data Fields
void(*	log )(ccl_notifier_context_t *notifier_context, const char *message)
	Logs a message related to video player monitoring through Conviva's logging system.
void(*	set_state )(ccl_notifier_context_t *notifier_context, ccl_player_state_t new_state)
	Notify Conviva of a change in player state.
void(*	set_stream )(ccl_notifier_context_t *notifier_context, int bitrate_kbps, const char *cdn, const char *resource)
	Notify Conviva of a change in the peak bitrate, CDN or resource.
void(*	set_error )(ccl_notifier_context_t *notifier_context, const char *error_message, int is_fatal)
	Notify Conviva of a video player error.
void(*	set_duration )(ccl_notifier_context_t *notifier_context, int duration)
	Notify Conviva of the duration (length) of the current video content in seconds.
void(*	set_encoded_framerate )(ccl_notifier_context_t *notifier_context, int framerate)
	Notify Conviva of the encoded framerate of the current video content. In frames per second.
void(*	set_video_size )(ccl_notifier_context_t *notifier_context, int width, int height)
	Notify Conviva of the video size of the current video content.
void(*	set_seek )(ccl_notifier_context_t *notifier_context, ccl_seek_action_t action, int seektoposition)
	Notify Conviva of the seek event.
void(*	set_CDNServerIP )(ccl_notifier_context_t *notifier_context, const char *CDNServerIP)
	Notify Conviva of a change in the CDN Server IP.
void(*	set_dropped_frame_total )(ccl_notifier_context_t *notifier_context, int dropped_frame_total)
	Notify Conviva of the cumulative dropped video frames since stream start.
void(*	set_dropped_frame_count )(ccl_notifier_context_t *notifier_context, int dropped_frame_count)
	Notify Conviva of the cumulative dropped video frames since stream start.
void(*	set_average_bitrate )(ccl_notifier_context_t *notifier_context, int avg_bitrate_kbps)
	Notify Conviva of a change in average bitrate currently used by the video player.
void(*	report_langauge_event )(ccl_notifier_context_t *notifier_context, ccl_langauge_event_type_t language_event, const char *language_name)
	Notify Conviva of a langauge change in audio/subtitle/closed caption.
void(*	reportAppForegrounded )(ccl_notifier_context_t *notifier_context)
	Notify Conviva of the app is foregrounded (from previously backgrouned).
void(*	reportAppBackgrounded )(ccl_notifier_context_t *notifier_context)
	Notify Conviva of the app is backgrounded.

Detailed Description

ccl_notifier_t is used to push video playback data notifications to the Conviva library.

Note

notifier_context is supplied by ccl_player_t::start_monitoring() during ccl_session_player_attach().

Field Documentation

log

void(* ccl_notifier_t::log) (ccl_notifier_context_t *notifier_context, const char *message)

Logs a message related to video player monitoring through Conviva's logging system.

Parameters

notifier_context	Notifier context for the notification.
message	Message to be logged.

report_langauge_event

void(* ccl_notifier_t::report_langauge_event) (ccl_notifier_context_t *notifier_context, ccl_langauge_event_type_t language_event, const char *language_name)

Notify Conviva of a langauge change in audio/subtitle/closed caption.

Parameters

notifier_context	Notifier context for the notification.
language_event	Type of the language change event
language_name	Name of the langauge

reportAppBackgrounded

void(* ccl_notifier_t::reportAppBackgrounded) (ccl_notifier_context_t *notifier_context)

Notify Conviva of the app is backgrounded.

Parameters

notifier_context

Notifier context for the notification.

reportAppForegrounded

void(* ccl_notifier_t::reportAppForegrounded) (ccl_notifier_context_t *notifier_context)

Notify Conviva of the app is foregrounded (from previously backgrouned).

Parameters

notifier_context

Notifier context for the notification.

set_average_bitrate

void(* ccl_notifier_t::set_average_bitrate) (ccl_notifier_context_t *notifier_context, int avg_bitrate_kbps)

Notify Conviva of a change in average bitrate currently used by the video player.

Parameters

notifier_context	Notifier context for the notification.
avg_bitrate_kbps	New average bitrate in Kbps..

set_CDNServerIP

void(* ccl_notifier_t::set_CDNServerIP) (ccl_notifier_context_t *notifier_context, const char *CDNServerIP)

Notify Conviva of a change in the CDN Server IP.

Parameters

notifier_context	Notifier context for the notification.
CDNServerIP	New CDN Edge Server IP used to serve video stream.

set_dropped_frame_count

void(* ccl_notifier_t::set_dropped_frame_count) (ccl_notifier_context_t *notifier_context, int dropped_frame_count)

Notify Conviva of the cumulative dropped video frames since stream start.

Parameters

notifier_context	Notifier context for the notification.
dropped_frame_count	Dropped video frame count since last reported.

set_dropped_frame_total

void(* ccl_notifier_t::set_dropped_frame_total) (ccl_notifier_context_t *notifier_context, int dropped_frame_total)

Notify Conviva of the cumulative dropped video frames since stream start.

Parameters

notifier_context	Notifier context for the notification.
dropped_frame_total	Dropped video frame total since stream start.

set_duration

void(* ccl_notifier_t::set_duration) (ccl_notifier_context_t *notifier_context, int duration)

Notify Conviva of the duration (length) of the current video content in seconds.

Parameters

notifier_context	Notifier context for the notification.
duration	Duration of the video context in seconds.

set_encoded_framerate

void(* ccl_notifier_t::set_encoded_framerate) (ccl_notifier_context_t *notifier_context, int framerate)

Notify Conviva of the encoded framerate of the current video content. In frames per second.

Parameters

notifier_context	Notifier context for the notification.
framerate	Encoded frame rate of the video content in frames per second.

set_error

void(* ccl_notifier_t::set_error) (ccl_notifier_context_t *notifier_context, const char *error_message, int is_fatal)

Notify Conviva of a video player error.

Parameters

notifier_context	Notifier context for the notification.
error_message	Error message.
is_fatal	Whether the error could prevent video playback altogether. When in doubt, set to true.

set_seek

void(* ccl_notifier_t::set_seek) (ccl_notifier_context_t *notifier_context, ccl_seek_action_t action, int seektoposition)

Notify Conviva of the seek event.

Parameters

notifier_context	Notifier context for the notification.
action	Seek action
seektoposition	seek to position

set_state

void(* ccl_notifier_t::set_state) (ccl_notifier_context_t *notifier_context, ccl_player_state_t new_state)

Notify Conviva of a change in player state.

Parameters

notifier_context	Notifier context for the notification.
new_state	The new player state.

See also

ccl_player_state_t

set_stream

void(* ccl_notifier_t::set_stream) (ccl_notifier_context_t *notifier_context, int bitrate_kbps, const char *cdn, const char *resource)

Notify Conviva of a change in the peak bitrate, CDN or resource.

Parameters

notifier_context	Notifier context for the notification.
bitrate_kbps	New peak bitrate currently used by the video player.
cdn	New CDN used to serve video streams.
resource	New resource used to serve video streams.

Note

Use -1 / NULL to keep maintain previous values.

set_video_size

void(* ccl_notifier_t::set_video_size) (ccl_notifier_context_t *notifier_context, int width, int height)

Notify Conviva of the video size of the current video content.

Parameters

notifier_context	Notifier context for the notification.
video	Resoluion (Width & Height) of the video content.