IMeetingVideoCtrlEvent Class Reference

Meeting video controller event callback. More...

#include <meeting_video_interface.h>

Public Member Functions
virtual	~IMeetingVideoCtrlEvent ()
virtual void	onUserVideoStatusChange (unsigned int userId, VideoStatus status)=0
	Callback event of the user video status changes.
virtual void	onSpotlightedUserListChangeNotification (IList< unsigned int > *lstSpotlightedUserID)=0
	Callback event for when the video spotlight user list changes. \Spotlight user means that the view will show only the \specified user and won't change the view even other users speak.
virtual void	onHostRequestStartVideo (IRequestStartVideoHandler *handler_)=0
	Callback event of the requirement to turn on the video from the host.
virtual void	onActiveSpeakerVideoUserChanged (unsigned int userid)=0
	Callback event of the active speaker video user changes.
virtual void	onActiveVideoUserChanged (unsigned int userid)=0
	Callback event of the active video user changes.
virtual void	onHostVideoOrderUpdated (IList< unsigned int > *orderList)=0
	Callback event of the video order changes.
virtual void	onLocalVideoOrderUpdated (IList< unsigned int > *localOrderList)=0
	Callback event of the local video order changes.
virtual void	onFollowHostVideoOrderChanged (bool bFollow)=0
	Notification the status of following host's video order changed.
virtual void	onUserVideoQualityChanged (VideoConnectionQuality quality, unsigned int userid)=0
	Callback event of the user video quality changes.
virtual void	onVideoAlphaChannelStatusChanged (bool isAlphaModeOn)=0
	Callback event of video alpha channel mode changes.
virtual void	onCameraControlRequestReceived (unsigned int userId, CameraControlRequestType requestType, ICameraControlRequestHandler *pHandler)=0
	Callback for when the current user receives a camera control request. \This callback will be triggered when another user requests control of the current user's camera.
virtual void	onCameraControlRequestResult (unsigned int userId, CameraControlRequestResult result)=0
	Callback for when the current user is granted camera control access.

Detailed Description

Meeting video controller event callback.

Definition at line 160 of file meeting_video_interface.h.

Constructor & Destructor Documentation

~IMeetingVideoCtrlEvent()

virtual IMeetingVideoCtrlEvent::~IMeetingVideoCtrlEvent ( )

inlinevirtual

Definition at line 163 of file meeting_video_interface.h.

{}

Member Function Documentation

onActiveSpeakerVideoUserChanged()

virtual void IMeetingVideoCtrlEvent::onActiveSpeakerVideoUserChanged ( unsigned int userid )

pure virtual

Callback event of the active speaker video user changes.

Parameters

userid

The ID of user who becomes the new active speaker.

onActiveVideoUserChanged()

virtual void IMeetingVideoCtrlEvent::onActiveVideoUserChanged ( unsigned int userid )

pure virtual

Callback event of the active video user changes.

Parameters

userid

The ID of user who becomes the new active speaker.

onCameraControlRequestReceived()

virtual void IMeetingVideoCtrlEvent::onCameraControlRequestReceived ( unsigned int userId, CameraControlRequestType requestType, ICameraControlRequestHandler * pHandler )

pure virtual

Callback for when the current user receives a camera control request. \This callback will be triggered when another user requests control of the current user's camera.

Parameters

userId	The user ID that sent the request
requestType	The request type. For more details, see CameraControlRequestType enum.
pHandler	A pointer to the ICameraControlRequestHandler. For more details, see ICameraControlRequestHandler.

onCameraControlRequestResult()

virtual void IMeetingVideoCtrlEvent::onCameraControlRequestResult ( unsigned int userId, CameraControlRequestResult result )

pure virtual

Callback for when the current user is granted camera control access.

Parameters

userId	The user ID that accepted the request
isApproved	The result of the camera control request.

onFollowHostVideoOrderChanged()

virtual void IMeetingVideoCtrlEvent::onFollowHostVideoOrderChanged ( bool bFollow )

pure virtual

Notification the status of following host's video order changed.

Parameters

follow

Yes means the option of following host's video order is on, otherwise not.

onHostRequestStartVideo()

virtual void IMeetingVideoCtrlEvent::onHostRequestStartVideo ( IRequestStartVideoHandler * handler_ )

pure virtual

Callback event of the requirement to turn on the video from the host.

Parameters

handler_

A pointer to the IRequestStartVideoHandler. For more details, see IRequestStartVideoHandler.

onHostVideoOrderUpdated()

virtual void IMeetingVideoCtrlEvent::onHostVideoOrderUpdated ( IList< unsigned int > * orderList )

pure virtual

Callback event of the video order changes.

Parameters

orderList

The video order list contains the user ID of listed users.

onLocalVideoOrderUpdated()

virtual void IMeetingVideoCtrlEvent::onLocalVideoOrderUpdated ( IList< unsigned int > * localOrderList )

pure virtual

Callback event of the local video order changes.

Parameters

localOrderList

The lcoal video order list contains the user ID of listed users.

onSpotlightedUserListChangeNotification()

virtual void IMeetingVideoCtrlEvent::onSpotlightedUserListChangeNotification ( IList< unsigned int > * lstSpotlightedUserID )

pure virtual

Callback event for when the video spotlight user list changes. \Spotlight user means that the view will show only the \specified user and won't change the view even other users speak.

Parameters

lstSpotlightedUserID

spot light user list.

onUserVideoQualityChanged()

virtual void IMeetingVideoCtrlEvent::onUserVideoQualityChanged ( VideoConnectionQuality quality, unsigned int userid )

pure virtual

Callback event of the user video quality changes.

Parameters

userId	The user ID whose video quality changes
quality	New video quality. For more details, see VideoConnectionQuality enum.

onUserVideoStatusChange()

virtual void IMeetingVideoCtrlEvent::onUserVideoStatusChange ( unsigned int userId, VideoStatus status )

pure virtual

Callback event of the user video status changes.

Parameters

userId	The user ID whose video status changes
status	New video status. For more details, see VideoStatus enum.

Remarks

Valid for both normal user and webinar attendee.

onVideoAlphaChannelStatusChanged()

virtual void IMeetingVideoCtrlEvent::onVideoAlphaChannelStatusChanged ( bool isAlphaModeOn )

pure virtual

Callback event of video alpha channel mode changes.

Parameters

isAlphaModeOn

true means it's in alpha channel mode. Otherwise, it's not.