Zoom Rooms Controller SDK Reference 7.2.0
Loading...
Searching...
No Matches
IClosedCaptionHelper.h File Reference

Closed Caption interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  NewMeetingTranscriptInfo
 New Cloud Transcription info. More...
 
struct  ClosedCaptionInfo
 Closed Caption info. More...
 
struct  NewLTTCaptionLanguage
 New LTT caption language If languageID is -1, indicates that current language is invalid. More...
 
struct  NewLTTCaptionSpeakerLanguageInfo
 New LTT caption speaking language info. More...
 
struct  NewLTTCaptionTranslationInfo
 New LTT caption translation info. More...
 
struct  NewLTTCaptionInfo
 New LTT caption info. More...
 
struct  InterpretLanguageInfoList
 Interpret language info list. More...
 
struct  LTTCaptionMessage
 LTT caption message. More...
 
struct  LTTCaptionInsertMessage
 LTT caption insert batch. More...
 
struct  LTTCaptionMessageComposite
 LTT caption composite notification (batch insert / delete / update). More...
 
class  IClosedCaptionHelperSink
 Closed Caption helper event callback. More...
 
class  IClosedCaptionHelper
 Closed Caption helper interface. More...
 

Enumerations

enum  ClosedCaptionFontSize { ClosedCaptionFontSizeSmall , ClosedCaptionFontSizeMedium , ClosedCaptionFontSizeLarge }
 Closed caption font size Here are more detailed structural descriptions. More...
 
enum  NewLTTCaptionNotificationType { NewLTTCaptionNotificationTypeCaptionStart , NewLTTCaptionNotificationTypeEnableCaptionRequestReceived , NewLTTCaptionNotificationTypeEnableCaptionRequestDeclined , NewLTTCaptionNotificationTypeSpeakerLanguageMismatch }
 NewLTT caption notification type Here are more detailed structural descriptions. More...
 
enum  LTTCaptionWritingDirection { LTTCaptionWritingDirectionLeftToRight = 0 , LTTCaptionWritingDirectionRightToLeft = 1 }
 LTT caption writing direction. Here are more detailed structural descriptions. More...
 
enum  LTTCaptionMessageResultType { LTTCaptionMessageResultTypeSuccess = 0 , LTTCaptionMessageResultTypeTranslationNotSupport = 1 , LTTCaptionMessageResultTypeSessionStarted , LTTCaptionMessageResultTypeSessionStopped }
 LTT caption message result type. Here are more detailed structural descriptions. More...
 
enum  NewMeetingTranscriptState {
  NewMeetingTranscriptStateNone = 0 , NewMeetingTranscriptStateStarted , NewMeetingTranscriptStateStopped , NewMeetingTranscriptStatePause ,
  NewMeetingTranscriptStateTimeout
}
 New Cloud Transcription state. Here are more detailed structural descriptions. More...
 

Detailed Description

Closed Caption interfaces.

Since
Added in ZRC SDK 6.0.0

Closed Caption function has 2 phases:

  1. Closed Caption
  2. New LTT Caption(Next Generation Live Transcription Translation)

NOTE: If NewLTTCaptionInfo.isNewLttCaptionFeatureOn = true, use New LTT APIs, else use Closed Caption.

Definition in file IClosedCaptionHelper.h.

Enumeration Type Documentation

◆ ClosedCaptionFontSize

Closed caption font size Here are more detailed structural descriptions.

Enumerator
ClosedCaptionFontSizeSmall 

Closed caption font size small.

ClosedCaptionFontSizeMedium 

Closed caption font size medium.

ClosedCaptionFontSizeLarge 

Closed caption font size large.

Definition at line 23 of file IClosedCaptionHelper.h.

24{
28};
@ ClosedCaptionFontSizeLarge
Closed caption font size large.
@ ClosedCaptionFontSizeSmall
Closed caption font size small.
@ ClosedCaptionFontSizeMedium
Closed caption font size medium.

◆ LTTCaptionMessageResultType

LTT caption message result type. Here are more detailed structural descriptions.

Enumerator
LTTCaptionMessageResultTypeSuccess 

Success.

LTTCaptionMessageResultTypeTranslationNotSupport 

Language translation not support.

LTTCaptionMessageResultTypeSessionStarted 

Message marks a new Cloud Transcription session start.

LTTCaptionMessageResultTypeSessionStopped 

Message marks a new Cloud Transcription session stop.

Definition at line 56 of file IClosedCaptionHelper.h.

57{
62};
@ 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.

◆ LTTCaptionWritingDirection

LTT caption writing direction. Here are more detailed structural descriptions.

Enumerator
LTTCaptionWritingDirectionLeftToRight 

Direction Left to Right.

LTTCaptionWritingDirectionRightToLeft 

Direction Right to Left.

Definition at line 46 of file IClosedCaptionHelper.h.

47{
50};
@ LTTCaptionWritingDirectionRightToLeft
Direction Right to Left.
@ LTTCaptionWritingDirectionLeftToRight
Direction Left to Right.

◆ NewLTTCaptionNotificationType

NewLTT caption notification type Here are more detailed structural descriptions.

Enumerator
NewLTTCaptionNotificationTypeCaptionStart 
NewLTTCaptionNotificationTypeEnableCaptionRequestReceived 
NewLTTCaptionNotificationTypeEnableCaptionRequestDeclined 
NewLTTCaptionNotificationTypeSpeakerLanguageMismatch 

Definition at line 34 of file IClosedCaptionHelper.h.

◆ NewMeetingTranscriptState

New Cloud Transcription state. Here are more detailed structural descriptions.

Enumerator
NewMeetingTranscriptStateNone 

No new Cloud Transcription session.

NewMeetingTranscriptStateStarted 

New Cloud Transcription is started.

NewMeetingTranscriptStateStopped 

New Cloud Transcription is stopped.

NewMeetingTranscriptStatePause 

New Cloud Transcription is paused.

NewMeetingTranscriptStateTimeout 

New Cloud Transcription session timed out.

Definition at line 68 of file IClosedCaptionHelper.h.

69{
75};
@ 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.