Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
IMeetingInfo Class Referenceabstract

Meeting information Interface. More...

#include <meeting_service_interface.h>

Public Member Functions

virtual UINT64 GetMeetingNumber ()=0
 Gets the current meeting number.
virtual const zchar_t * GetMeetingID ()=0
 Gets the current meeting ID.
virtual const zchar_t * GetMeetingTopic ()=0
 Gets the meeting topic.
virtual const zchar_t * GetMeetingPassword ()=0
 Gets the meeting password.
virtual MeetingType GetMeetingType ()=0
 Gets the current meeting's type.
virtual const zchar_t * GetInviteEmailTemplate ()=0
 Gets the email invitation template for the current meeting.
virtual const zchar_t * GetInviteEmailTitle ()=0
 Gets the meeting title in the email invitation template.
virtual const zchar_t * GetJoinMeetingUrl ()=0
 Gets the URL of invitation to join the meeting.
virtual const zchar_t * GetMeetingHostTag ()=0
 Gets the host tag of the current meeting.
virtual MeetingConnType GetMeetingConnType ()=0
 Gets the connection type of the current meeting.
virtual int GetSupportedMeetingAudioType ()=0
 Gets the audio type supported by the current meeting. see InMeetingSupportAudioType enum.
virtual ~IMeetingInfo ()

Detailed Description

Meeting information Interface.

Definition at line 679 of file meeting_service_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingInfo()

virtual IMeetingInfo::~IMeetingInfo ( )
inlinevirtual

Definition at line 750 of file meeting_service_interface.h.

750{};

Member Function Documentation

◆ GetInviteEmailTemplate()

virtual const zchar_t * IMeetingInfo::GetInviteEmailTemplate ( )
pure virtual

Gets the email invitation template for the current meeting.

Returns
If the function succeeds, the return value is the email invitation template. Otherwise returns nullptr.

◆ GetInviteEmailTitle()

virtual const zchar_t * IMeetingInfo::GetInviteEmailTitle ( )
pure virtual

Gets the meeting title in the email invitation template.

Returns
If the function succeeds, the return value is the meeting title. Otherwise returns nullptr.

◆ GetJoinMeetingUrl()

virtual const zchar_t * IMeetingInfo::GetJoinMeetingUrl ( )
pure virtual

Gets the URL of invitation to join the meeting.

Returns
If the function succeeds, the return value is the URL of invitation. Otherwise returns nullptr.

◆ GetMeetingConnType()

virtual MeetingConnType IMeetingInfo::GetMeetingConnType ( )
pure virtual

Gets the connection type of the current meeting.

Returns
The connection type.

◆ GetMeetingHostTag()

virtual const zchar_t * IMeetingInfo::GetMeetingHostTag ( )
pure virtual

Gets the host tag of the current meeting.

Returns
If the function succeeds, the return value is the host tag. Otherwise returns nullptr.

◆ GetMeetingID()

virtual const zchar_t * IMeetingInfo::GetMeetingID ( )
pure virtual

Gets the current meeting ID.

Returns
If the function succeeds, the return value is the current meeting ID. Otherwise returns an empty string of length ZERO(0).

◆ GetMeetingNumber()

virtual UINT64 IMeetingInfo::GetMeetingNumber ( )
pure virtual

Gets the current meeting number.

Returns
If the function succeeds, the return value is the current meeting number. Otherwise returns ZERO(0).

◆ GetMeetingPassword()

virtual const zchar_t * IMeetingInfo::GetMeetingPassword ( )
pure virtual

Gets the meeting password.

Returns
If the function succeeds, the return value is the current meeting password. Otherwise, this function fails and returns an empty string of length ZERO(0).

◆ GetMeetingTopic()

virtual const zchar_t * IMeetingInfo::GetMeetingTopic ( )
pure virtual

Gets the meeting topic.

Returns
If the function succeeds, the return value is the current meeting topic. Otherwise, this function fails and returns an empty string of length ZERO(0).

◆ GetMeetingType()

virtual MeetingType IMeetingInfo::GetMeetingType ( )
pure virtual

Gets the current meeting's type.

Returns
The meeting's type.
Note
Returns MEETING_TYPE_BACKSTAGE while the local user is in the webinar backstage, and MEETING_TYPE_WEBINAR after the local user returns to the main session.

◆ GetSupportedMeetingAudioType()

virtual int IMeetingInfo::GetSupportedMeetingAudioType ( )
pure virtual

Gets the audio type supported by the current meeting. see InMeetingSupportAudioType enum.

Returns
If the function succeeds, it will return the type. The value is the 'bitwise OR' of each supported audio type.