Zoom Rooms Controller SDK Reference 7.2.0
Loading...
Searching...
No Matches
IClosedCaptionHelper.h
Go to the documentation of this file.
1
12#ifndef ZRC_ICLOSEDCAPTIONHELPER_H
13#define ZRC_ICLOSEDCAPTIONHELPER_H
14
15#include "ZRCSDKTypes.h"
16
18
24{
28};
29
35{
40};
41
47{
50};
51
57{
62};
63
69{
75};
76
81{
82 bool isEnabled = false;
83 bool isUsable = false;
85 bool isPanelShownOnTV = false;
86 bool canAskHostToSwitch = false;
87};
88
92{
93 bool available = false;
94 bool visible = false;
96};
97
101{
102 int32_t languageID = -1;
103 std::string displayName;
104 std::string abbreviatedName;
105};
106
110{
112 std::vector<NewLTTCaptionLanguage> availableLanguages;
113};
114
118{
120 std::vector<NewLTTCaptionLanguage> availableLanguages;
121 std::vector<NewLTTCaptionLanguage> recentlyUsedLanguages;
122};
123
127{
131 bool isShowCaptionOn = false;
138 bool isCaptionDisabled = false;
139 bool isAllowShowCaption = false;
143};
144
148{
149 bool isAvailable = false;
150 bool isOriginalAudioMuted = false;
151 std::vector<InterpretLanguageInfo> languages;
153};
154
158{
160 std::string messageID;
161 int32_t userNodeID = 0;
162 std::string userName;
163 int64_t messageTime = 0;
164 std::string messageContent;
166 int32_t speakerTagID = 0;
167 std::string speakerTagName;
169 std::string attendeeJid;
170};
171
175{
176 std::string insertAfterID;
177 std::vector<LTTCaptionMessage> messages;
178};
179
183{
184 std::vector<LTTCaptionMessage> updateMessages;
185 std::vector<std::string> deleteMessageIDs;
186 std::vector<LTTCaptionInsertMessage> insertMessages;
187};
188
192{
193public:
195
204 virtual void OnUpdateClosedCaptionNotification(const ClosedCaptionInfo& closedCaptionInfo) = 0;
205
215 virtual void OnClosedCaptionResponse(int32_t result, ClosedCaptionFontSize fontSize) = 0;
216
225 virtual void OnNewLTTLanguageNotification(const NewLTTCaptionInfo& newLttCaptionInfo) = 0;
226
236
246
255 virtual void OnMessageAdd(const LTTCaptionMessage& message) = 0;
256
265 virtual void OnMessageUpdate(const LTTCaptionMessage& message) = 0;
266
275 virtual void OnMessageNotSupported(const LTTCaptionMessage& message) = 0;
276
286 virtual void OnMessageLoad(const std::vector<LTTCaptionMessage>& messages, bool hasMoreHistory) = 0;
287
297
306 virtual void OnMessageComposite(const LTTCaptionMessageComposite& notification) = 0;
307
317 virtual void OnReceiveMeetingTranscriptRequest(bool start, int32_t askUserID) = 0;
318
328};
329
333{
334public:
336
348
360
361 // CLOSED CAPTION
362
375
387 virtual ZRCSDKError AssignClosedCaption(int32_t userID, bool assign) = 0;
388
389 // Next Generation Language Transcription Translation
390
401 virtual ZRCSDKError ShowCaption(bool show) = 0;
402
414
425 virtual ZRCSDKError EnableNewLTTManualCaptioner(bool enable) = 0;
426
437 virtual ZRCSDKError SetNewLTTSpeakerLanguage(int32_t languageID) = 0;
438
449 virtual ZRCSDKError SetNewLTTTranslationLanguage(int32_t languageID) = 0;
450
462
473
484 virtual ZRCSDKError ApproveEnableCaptionRequest(bool approve) = 0;
485
496 virtual ZRCSDKError EnableCaption(bool enable) = 0;
497
512
513 // Interpret Language
514
525 virtual ZRCSDKError MuteOriginalAudio(bool mute) = 0;
526
538
550
551 //LTT Caption message
552
563 virtual ZRCSDKError ShowTranscriptPanelOnZR(bool show) = 0;
564
575 virtual ZRCSDKError ShowTranscriptPanelOnZRC(bool show) = 0;
576
587
598 virtual ZRCSDKError IsAllowViewFullTranscript(bool& isAllow) = 0;
599
610 virtual ZRCSDKError GetLTTCaptionMessageList(std::vector<LTTCaptionMessage>& messages) = 0;
611
622 virtual ZRCSDKError HasMoreMessageHistoryOnZR(bool& hasMore) = 0;
623
635
647 virtual ZRCSDKError StopMeetingTranscript(bool deleteAssets) = 0;
648
661};
662
664
665#endif //ZRC_ICLOSEDCAPTIONHELPER_H
ClosedCaptionFontSize
Closed caption font size Here are more detailed structural descriptions.
@ ClosedCaptionFontSizeLarge
Closed caption font size large.
@ ClosedCaptionFontSizeSmall
Closed caption font size small.
@ ClosedCaptionFontSizeMedium
Closed caption font size medium.
NewLTTCaptionNotificationType
NewLTT caption notification type Here are more detailed structural descriptions.
@ NewLTTCaptionNotificationTypeEnableCaptionRequestDeclined
@ NewLTTCaptionNotificationTypeCaptionStart
@ NewLTTCaptionNotificationTypeEnableCaptionRequestReceived
@ NewLTTCaptionNotificationTypeSpeakerLanguageMismatch
NewMeetingTranscriptState
New Cloud Transcription state. Here are more detailed structural descriptions.
@ NewMeetingTranscriptStateTimeout
New Cloud Transcription session timed out.
@ NewMeetingTranscriptStateNone
No new Cloud Transcription session.
@ NewMeetingTranscriptStateStarted
New Cloud Transcription is started.
@ NewMeetingTranscriptStatePause
New Cloud Transcription is paused.
@ NewMeetingTranscriptStateStopped
New Cloud Transcription is stopped.
LTTCaptionWritingDirection
LTT caption writing direction. Here are more detailed structural descriptions.
@ LTTCaptionWritingDirectionRightToLeft
Direction Right to Left.
@ LTTCaptionWritingDirectionLeftToRight
Direction Left to Right.
LTTCaptionMessageResultType
LTT caption message result type. Here are more detailed structural descriptions.
@ LTTCaptionMessageResultTypeTranslationNotSupport
Language translation not support.
@ LTTCaptionMessageResultTypeSessionStarted
Message marks a new Cloud Transcription session start.
@ LTTCaptionMessageResultTypeSuccess
Success.
@ LTTCaptionMessageResultTypeSessionStopped
Message marks a new Cloud Transcription session stop.
#define NS_ZRCSDK_END
#define NS_ZRCSDK_BEG
ZRC SDK Types.
ZRCSDKError
SDK error types. Here are more detailed structural descriptions.
Definition ZRCSDKTypes.h:23
Closed Caption helper interface.
virtual ZRCSDKError ShowCaption(bool show)=0
Control New LTT caption visibility.
virtual ZRCSDKError GetRecommendSpeakerLanguageInfo(NewLTTCaptionLanguage &recommendLanguage)=0
Query recommend speaker language for closed caption.
virtual ZRCSDKError EnableNewLTTManualCaptioner(bool enable)=0
Enable New LTT manual captioner.
virtual ZRCSDKError AssignClosedCaption(int32_t userID, bool assign)=0
Assign user to type closed caption.
virtual ZRCSDKError GetNewMeetingTranscriptInfo(NewMeetingTranscriptInfo &info)=0
Get current new Cloud Transcription info,.
virtual ZRCSDKError DeregisterSink(IClosedCaptionHelperSink *pSink)=0
Deregister closed caption helper callback sink.
virtual ZRCSDKError LoadLTTCaptionMessage()=0
Load more LTT caption history messages step by 20.
virtual ZRCSDKError ShowNewLTTOriginalAndTranslated(bool show)=0
Show New LTT caption both original and translated caption.
virtual ZRCSDKError SelectInterpretLanguage(const InterpretLanguageInfo &languageInfo)=0
Select interpret language.
virtual ZRCSDKError HasMoreMessageHistoryOnZR(bool &hasMore)=0
Query if has more history on ZR.
virtual ZRCSDKError SetNewLTTSpeakerLanguage(int32_t languageID)=0
Set New LTT caption speaker language.
virtual ZRCSDKError StopMeetingTranscript(bool deleteAssets)=0
Stop new Cloud Transcription for current meeting. Host/cohost directly switches it off; otherwise thi...
virtual ZRCSDKError GetLTTCaptionMessageList(std::vector< LTTCaptionMessage > &messages)=0
Get current loaded LTT caption message list.
virtual ZRCSDKError RegisterSink(IClosedCaptionHelperSink *pSink)=0
Register closed caption helper callback sink.
virtual ZRCSDKError StartMeetingTranscript()=0
Start new Cloud Transcription for current meeting. Host/cohost directly switches it on; otherwise thi...
virtual ZRCSDKError EnableCaption(bool enable)=0
Enable caption.
virtual ZRCSDKError ApproveEnableCaptionRequest(bool approve)=0
Approve enable caption request.
virtual ZRCSDKError ShowTranscriptPanelOnZR(bool show)=0
Show transcript panel on ZR display.
virtual ZRCSDKError ShowTranscriptPanelOnZRC(bool show)=0
Show transcript panel on controller.
virtual ZRCSDKError SetNewLTTTranslationLanguage(int32_t languageID)=0
Set New LTT caption translation language.
virtual ZRCSDKError SetNewLTTCaptionFontSize(ClosedCaptionFontSize fontSize)=0
Control New LTT caption font size.
virtual ZRCSDKError MuteOriginalAudio(bool mute)=0
Mute original audio.
virtual ZRCSDKError SendEnableCaptionRequest()=0
Send enable caption request to host.
virtual ZRCSDKError GetInterpretLanguageInfoList(InterpretLanguageInfoList &infoList)=0
Query the list of supported interpretation languages.
virtual ZRCSDKError IsAllowViewFullTranscript(bool &isAllow)=0
Query if is allow view full transcript.
virtual ZRCSDKError ControlClosedCaptionVisible(bool show, ClosedCaptionFontSize fontSize)=0
Control closed caption visibility and font size.
Closed Caption helper event callback.
virtual void OnUpdateClosedCaptionNotification(const ClosedCaptionInfo &closedCaptionInfo)=0
Closed caption info changed callback.
virtual void OnReceiveMeetingTranscriptRequest(bool start, int32_t askUserID)=0
Notification that a participant asked host/cohost to start or stop new Cloud Transcription.
virtual void OnUpdateInterpretLanguageNotification(const InterpretLanguageInfoList &infoList)=0
Interpret language info update notification.
virtual void OnUpdateMeetingTranscriptInfo(const NewMeetingTranscriptInfo &info)=0
New Cloud Transcription info update notification.
virtual void OnNewLTTCaptionNotification(NewLTTCaptionNotificationType type)=0
New LTT caption notification.
virtual void OnMessageUpdate(const LTTCaptionMessage &message)=0
LTT caption message update notification.
virtual void OnMessageInstanceOnlySpeakerTagUpdate(const LTTCaptionMessage &message)=0
LTT caption message instance only smart speaker tag update notification.
virtual void OnNewLTTLanguageNotification(const NewLTTCaptionInfo &newLttCaptionInfo)=0
New LTT caption info changed callback.
virtual void OnMessageLoad(const std::vector< LTTCaptionMessage > &messages, bool hasMoreHistory)=0
LTT caption messages loaded notification.
virtual void OnMessageComposite(const LTTCaptionMessageComposite &notification)=0
LTT caption composite notification for batched insert, delete, and update.
virtual void OnClosedCaptionResponse(int32_t result, ClosedCaptionFontSize fontSize)=0
Closed caption control response callback.
virtual void OnMessageAdd(const LTTCaptionMessage &message)=0
LTT caption message add notification.
virtual void OnMessageNotSupported(const LTTCaptionMessage &message)=0
LTT caption message not supported notification.
Closed Caption info.
bool available
TRUE indicates closed caption is available. Otherwise not.
ClosedCaptionFontSize fontSize
Closed caption font size.
bool visible
TRUE indicates closed caption is visible. Otherwise not.
Interpret language information.
Interpret language info list.
bool isAvailable
TRUE indicates interpret language is available.
std::vector< InterpretLanguageInfo > languages
Supported interpret language list.
InterpretLanguageInfo activeLanguage
Active interpret language.
bool isOriginalAudioMuted
TRUE indicates interpret language original audio is muted.
LTT caption insert batch.
std::string insertAfterID
Insert after this existing message ID.
std::vector< LTTCaptionMessage > messages
Messages to insert.
LTT caption composite notification (batch insert / delete / update).
std::vector< LTTCaptionMessage > updateMessages
Messages to update.
std::vector< LTTCaptionInsertMessage > insertMessages
Message batches to insert.
std::vector< std::string > deleteMessageIDs
Message IDs to delete.
LTT caption message.
int64_t messageTime
Message time.
SmartTagUser instanceOnlySpeakerTag
Instance only smart speaker tag only for individual message.
std::string attendeeJid
An attendee's attendeeJid remains unchanged when switching between main session and sub-session.
std::string speakerTagName
Smart speaker tag speaker name.
LTTCaptionMessageResultType result
Message result type.
std::string messageContent
Message content.
LTTCaptionWritingDirection direction
Message writing direction.
std::string userName
User name.
std::string messageID
Message ID.
int32_t userNodeID
User node ID, compare it with MeetingParticipant userID.
int32_t speakerTagID
Smart speaker tag speaker ID.
New LTT caption info.
bool isShowCaptionOn
TRUE indicates show caption is on. Otherwise not.
bool isCaptionDisabled
TRUE indicates caption is disabled.
bool isAllowShowCaption
TRUE indicates allow show caption.
NewLTTCaptionSpeakerLanguageInfo speakingLanguageInfo
New LTT caption speaker language info.
bool isShowTranscriptPanelOnZR
TRUE indicates is showing transcript panel on ZR.
bool isMmrSupportDisableLttCaption
TRUE indicates current meeting server supports disable LTT caption.
bool isAllowViewFullTranscript
TRUE indicates allow view full transcript.
NewLTTCaptionTranslationInfo translationInfo
New LTT caption translation info.
bool isManualCaptionerEnabled
TRUE indicates manual captioner is enabled. Otherwise not.
bool isAutomatedCaptionFeatureOn
TRUE indicates automated caption is enabled. Otherwise not.
ClosedCaptionFontSize fontSize
Caption font size, see ClosedCaptionFontSize enum.
bool isNewLttCaptionFeatureOn
TRUE indicates New LTT is enabled. Otherwise only Closed Caption is enabled.
bool isAllowRequestCaption
TRUE indicates allow request caption.
bool isShowOriginalAndTranslated
TRUE indicates showing original and translated. Otherwise not.
bool isTranslatedCaptionFeatureOn
TRUE indicates translated caption is enabled. Otherwise not.
New LTT caption language If languageID is -1, indicates that current language is invalid.
int32_t languageID
Language ID defined and used between Controller and Zoom Room.
std::string displayName
Language display name.
std::string abbreviatedName
Language abbreviated name.
New LTT caption speaking language info.
NewLTTCaptionLanguage currentLanguage
Current selected language.
std::vector< NewLTTCaptionLanguage > availableLanguages
Available languages.
New LTT caption translation info.
NewLTTCaptionLanguage currentLanguage
Current selected language.
std::vector< NewLTTCaptionLanguage > availableLanguages
Available languages.
std::vector< NewLTTCaptionLanguage > recentlyUsedLanguages
Recently used languages.
New Cloud Transcription info.
bool canAskHostToSwitch
TRUE indicates a non-host/cohost caller can ask host/cohost to start/stop new Cloud Transcription....
bool isUsable
TRUE indicates new Cloud Transcription is usable in the current session. Otherwise the legacy caption...
NewMeetingTranscriptState state
Current new Cloud Transcription state.
bool isPanelShownOnTV
TRUE indicates the transcript panel is currently shown on the Zoom Room TV. Otherwise not.
bool isEnabled
TRUE indicates new Cloud Transcription is enabled for the account/meeting. Otherwise not.
Smart tag user.