Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Meeting Control Objects/ Subscribing to Notifications of Ongoing Meeting Information Changes

Updated on 2024-09-13 GMT+08:00

View PDF

Subscribing to Notifications of Ongoing Meeting Information Changes

Function

This API is used to subscribe to notifications of ongoing meeting information changes.

Function Prototype

setOnMeetingInfoChangedCB(onMeetingInfoChanged: (meetingInfo: MeetingInfo) => void): voidsetOnMeetingInfoChangedCB(onMeetingInfoChanged: (meetingInfo: MeetingInfo) => void): void

Request Parameters

**Table 1** Input parameter description
Parameter	Mandatory	Type	Description
onMeetingInfoChanged	Yes	(meetingInfo: MeetingInfo) => void	Notification of ongoing meeting information changes.

Return Values

void

Notification Method Parameters

(meetingInfo: MeetingInfo) => void

**Table 2** Input parameter description
Parameter	Type	Description
meetingInfo	MeetingInfo	Ongoing meeting information.

**Table 3** MeetingInfo
Parameter	Type	Description
baseInfo	ConfBaseInfo	Basic meeting information.
orgId	string	Enterprise ID.
recordMode	ConfRecordMode	Media recording mode.
supportBreakoutConf	boolean	Whether breakout rooms are supported.
isBreakoutSubConf	boolean	Whether the session is a breakout room.

**Table 4** ConfBaseInfo
Parameter	Type	Description
confId	string	Meeting ID, which used to join a meeting. If the meeting is held in a cloud meeting room, this ID is the actual meeting ID.
vmrConfId	string	ID of the meeting when it is held in a cloud meeting room.
confSubject	string	Meeting topic.
startTime	number	Meeting start timestamp, accurate to seconds (GMT).
endTime	number	Meeting end timestamp, accurate to seconds (GMT).
timeZone	string	Time zone.
hostPwd	string	Host password.
guestPwd	string	Guest password.
scheduserUuid	string	Scheduler UUID.
scheduserName	string	Scheduler name.
hostJoinUri	string	Link for the host to join the meeting.
guestJoinUri	string	Link for guests to join the meeting.
selfConfRole	ConfRole	Role in the meeting. Example: host or guest.
isWebinar	boolean	Whether the meeting is a webinar.
isCreator	boolean	Whether the meeting was scheduled by you.
audienceJoinUri	string	Link for attendees to join the webinar.
audiencePwd	string	Attendee password.
conferenceType	ConferenceType	Meeting type.
confUuid	string	Meeting UUID.
openCustomPara	string	Custom extension information.
liveRoomAddress	string	Live broadcast address.
isHighResolution	boolean	Whether the meeting resolution is ultra-HD (1080p).
isP2PConf	boolean	Whether the meeting is an instant meeting.
supportSummary	boolean	Whether meeting minutes are supported.
defaultSummaryState	SummaryState	Meeting minutes status.

**Table 5** Enumerated values of MediaType
Enumeration Name	Enumerated Value	Description
HWM_MEDIA_TYPE_AUDIO	0	Audio.
HWM_MEDIA_TYPE_VIDEO	1	Video.

**Table 6** Enumerated values of ConfRole
Enumeration Name	Enumerated Value	Description
HWM_CONF_ROLE_ATTENDEE	0	Guest.
HWM_CONF_ROLE_HOST	1	Host.
HWM_CONF_ROLE_AUDIENCE	2	Attendee.
HWM_CONF_ROLE_COHOST	3	Co-host.
HWM_CONF_ROLE_WAITING	4	Waiting room member.

**Table 7** Enumerated values of ConfState
Enumeration Name	Enumerated Value	Description
HWM_CONF_STATE_SCHEDULE	0	The meeting is scheduled.
HWM_CONF_STATE_CREATING	1	The meeting is being created.
HWM_CONF_STATE_GOING	2	The meeting has started.
HWM_CONF_STATE_DESTROYED	3	The meeting has ended.

**Table 8** Enumerated values of ConferenceType
Enumeration Name	Enumerated Value	Description
HWM_CONF_TYPE_COMMON	0	Common meeting.
HWM_CONF_TYPE_CYCLE	1	Recurring meeting.

**Table 9** CycleConfParam
Parameter	Type	Description
startDate	number	Start date and timestamp, accurate to seconds (GMT).
endDate	number	End date and timestamp, accurate to seconds (GMT).
cycleType	CycleType	Period type.
interval	number	Interval of recurring meetings. If cycleType is set to daily, there is a meeting every several days and the value range is [1,15]. If cycleType is set to weekly, there is a meeting every several weeks and the value range is [1,5]. If cycleType is set to monthly, there is a meeting every several months and the value range is [1,3].
listPoints	string	Meeting start points in the specified period. This parameter is valid only when meetings are held weekly or monthly. Values are separated by colons (,), for example, 1,3,5,7.
preRemindDays	number	Number of days in advance users are notified of a recurring meeting.

**Table 10** Enumerated values of CycleType
Enumeration Name	Enumerated Value	Description
CYCLE_TYPE_DAY	0	Daily.
CYCLE_TYPE_WEEK	1	Weekly.
CYCLE_TYPE_MONTH	2	Monthly.

**Table 11** SubCycleConfParam
Parameter	Type	Description
subConfID	string	UUID of a recurring meeting.
mediaType	MediaType	Media type.
startTime	number	Meeting start time.
endTime	number	Meeting end time.
isAutoRecord	boolean	Whether to automatically start recording after a meeting starts.
recordAuthType	RecordAuthType	Recording authentication mode.
confAllowJoinUser	ConfAllowJoinUserType	Users who are allowed to join the meeting. By default, everyone is allowed.
allowGuestStartConf	boolean	Whether to allow guests to start the meeting.
allowGuestStartConfTime	number	Time range for a guest to join the meeting in advance, in minutes. 0: at any time; n: n minutes in advance.

**Table 12** Enumerated values of RecordAuthType
Enumeration Name	Enumerated Value	Description
REOCRD_AUTH_TYPE_ANYONE	0	The recording can be viewed or downloaded through link (no nonce is added).
REOCRD_AUTH_TYPE_IN_COMPANY_USER	1	Corporate users can view or download the recording.
REOCRD_AUTH_TYPE_ATTENDEE	2	Participants can view or download the recording.

**Table 13** Enumerated values of ConfAllowJoinUserType
Enumeration Name	Enumerated Value	Description
CONF_ALLOW_JOIN_ANYONE	0	Everyone.
CONF_ALLOW_JOIN_LOGINED_USER	1	Logged-in users.
CONF_ALLOW_JOIN_IN_COMPANY_USER	2	Corporate users only.
CONF_ALLOW_JOIN_INVITED_USER	3	Invited users only.