- Generated by
1.9.6
|
macOS SDK API Reference
|
#import <ZoomSDKCloseCaptionController.h>
Inherits NSObject.
Instance Methods | |
| (BOOL) | - isMeetingSupportCloseCaption |
| Query if Close Caption is supported in the current meeting. | |
| (BOOL) | - canAssignOthersToSendCC |
| Query if it is able to assign others to send Close Caption. | |
| (BOOL) | - canBeAssignedToSendCC: |
| Query if the specified user can be assigned to send close caption. | |
| (BOOL) | - canSendClosedCaption |
| Query if the current user can send Close Caption. | |
| (BOOL) | - isCanSaveClosedCaption |
| Query if user can save Close Caption. | |
| (BOOL) | - is3rdPartCCServerAvailable |
| Query if the third party close caption server is available. | |
| (ZoomSDKError) | - withdrawCCPriviledgeForUser: |
| This method is used for host to withdraw CC privilege from another user. | |
| (ZoomSDKError) | - assignCCPriviledgeTo: |
| This method is used for host to assign CC privilege to another user. | |
| (ZoomSDKError) | - sendClosedCaptionMessage: |
| Send CC message. | |
| (ZoomSDKError) | - saveCCHistory |
| Save CC. | |
| (NSString *) | - getClosedCaptionHistorySavedPath |
| Get the path where the CC is saved. | |
| (ZoomSDKError) | - getClosedCaptionUrlFor3rdParty: |
| Get the third party URL which is used to input CC. | |
| (BOOL) | - isLiveTranscriptLegalNoticeAvailable |
| Determine whether the legal notice for Live transcript is available. | |
| (NSString *) | - getLiveTranscriptLegalNoticesPrompt |
| Get the CC legal notices prompt. | |
| (NSString *) | - getLiveTranscriptLegalNoticesExplained |
| Get the CC legal notices explained. | |
| (BOOL) | - isLiveTranscriptionFeatureEnabled |
| Determine whether the live transcription feature is enabled. | |
| (BOOL) | - isMultiLanguageTranscriptionEnabled |
| Determine whether the multi-language transcription feature is enabled. | |
| (BOOL) | - isTextLiveTranslationEnabled |
| Determine whether the translated captions feature is enabled. | |
| (ZoomSDKLiveTranscriptionStaus) | - getLiveTranscriptionStatus |
| Query the status of live transcription. | |
| (ZoomSDKError) | - canStartLiveTranscription |
| Query if it is able to start live transcription. | |
| (ZoomSDKError) | - startLiveTranscription |
| Start live transcription. | |
| (ZoomSDKError) | - stopLiveTranscription |
| Stop live transcription. | |
| (ZoomSDKError) | - enableRequestLiveTranscription: |
| Enable or disable the ability for attendees to request live transcriptions. | |
| (ZoomSDKError) | - isRequestToStartLiveTranscriptionEnabled |
| Determine whether the request to start live transcription is enabled. | |
| (ZoomSDKError) | - requestToStartLiveTranscription: |
| Request the host to start ive transcription. | |
| (ZoomSDKError) | - enableMeetingManualCaption: |
| Enable or disable manual captions for the meeting. | |
| (BOOL) | - isMeetingManualCaptionEnabled |
| Determine whether manually added closed captions is enabled for the meeting. | |
| (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) | - getAvailableMeetingSpokenLanguages |
| Get the list of all available spoken languages in a meeting. | |
| (ZoomSDKError) | - setMeetingSpokenLanguage: |
| Set the spoken language of the current user. | |
| (ZoomSDKLiveTranscriptionLanguage *) | - getMeetingSpokenLanguage |
| Get the spoken language of the current user. | |
| (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) | - getAvailableTranslationLanguages |
| Get the list of all available translation languages in a meeting. | |
| (ZoomSDKError) | - setTranslationLanguage: |
| Set the translation language of the current user. | |
| (ZoomSDKLiveTranscriptionLanguage *) | - getTranslationLanguage |
| Get the translation language of the current user. | |
| (ZoomSDKError) | - enableReceiveSpokenLanguageContent: |
| Enable or disable to receive original and translated content.If enable this feature,you need start live transcription. | |
| (BOOL) | - isReceiveSpokenLanguageContentEnabled |
| Determine whether receive original and translated is available. | |
| (BOOL) | - canDisableCaptions |
| Query if the user can disable captions. | |
| (ZoomSDKError) | - enableCaptions: |
| Enable or disable captions. | |
| (BOOL) | - isCaptionsEnabled |
| Query if the captions enabled. | |
Protected Attributes | |
| id< ZoomSDKCloseCaptionControllerDelegate > | _delegate |
Properties | |
| id< ZoomSDKCloseCaptionControllerDelegate > | delegate |
Definition at line 80 of file ZoomSDKCloseCaptionController.h.
| - (ZoomSDKError) assignCCPriviledgeTo: | (unsigned int) | userID |
This method is used for host to assign CC privilege to another user.
| userID | The ID of user whom you want to assign CC privilege to. |
| - (BOOL) canAssignOthersToSendCC |
Query if it is able to assign others to send Close Caption.
| - (BOOL) canBeAssignedToSendCC: | (unsigned int) | userID |
Query if the specified user can be assigned to send close caption.
| userID | The ID of user who you want to assign to send close caption |
| - (BOOL) canDisableCaptions |
Query if the user can disable captions.
| - (BOOL) canSendClosedCaption |
Query if the current user can send Close Caption.
| - (ZoomSDKError) canStartLiveTranscription |
Query if it is able to start live transcription.
| - (ZoomSDKError) enableCaptions: | (BOOL) | enable |
Enable or disable captions.
| enable | YES means that captions are enabled; NO means that captions are disabled. |
| - (ZoomSDKError) enableMeetingManualCaption: | (BOOL) | bEnable |
Enable or disable manual captions for the meeting.
| bEnable | YES means enable, otherwise not. |
| - (ZoomSDKError) enableReceiveSpokenLanguageContent: | (BOOL) | enable |
Enable or disable to receive original and translated content.If enable this feature,you need start live transcription.
| - (ZoomSDKError) enableRequestLiveTranscription: | (BOOL) | bEnable |
Enable or disable the ability for attendees to request live transcriptions.
| bEnable | YES means enable, otherwise not. |
| - (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableMeetingSpokenLanguages |
Get the list of all available spoken languages in a meeting.
| - (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableTranslationLanguages |
Get the list of all available translation languages in a meeting.
| - (NSString *) getClosedCaptionHistorySavedPath |
Get the path where the CC is saved.
| - (ZoomSDKError) getClosedCaptionUrlFor3rdParty: | (NSString **) | thirdPartyURL |
Get the third party URL which is used to input CC.
| thirdPartyURL | The URL of the third party service. |
| - (ZoomSDKLiveTranscriptionStaus) getLiveTranscriptionStatus |
Query the status of live transcription.
| - (NSString *) getLiveTranscriptLegalNoticesExplained |
Get the CC legal notices explained.
| - (NSString *) getLiveTranscriptLegalNoticesPrompt |
Get the CC legal notices prompt.
| - (ZoomSDKLiveTranscriptionLanguage *) getMeetingSpokenLanguage |
Get the spoken language of the current user.
| - (ZoomSDKLiveTranscriptionLanguage *) getTranslationLanguage |
Get the translation language of the current user.
| - (BOOL) is3rdPartCCServerAvailable |
Query if the third party close caption server is available.
| - (BOOL) isCanSaveClosedCaption |
Query if user can save Close Caption.
| - (BOOL) isCaptionsEnabled |
Query if the captions enabled.
| - (BOOL) isLiveTranscriptionFeatureEnabled |
Determine whether the live transcription feature is enabled.
| - (BOOL) isLiveTranscriptLegalNoticeAvailable |
Determine whether the legal notice for Live transcript is available.
| - (BOOL) isMeetingManualCaptionEnabled |
Determine whether manually added closed captions is enabled for the meeting.
| - (BOOL) isMeetingSupportCloseCaption |
Query if Close Caption is supported in the current meeting.
| - (BOOL) isMultiLanguageTranscriptionEnabled |
Determine whether the multi-language transcription feature is enabled.
| - (BOOL) isReceiveSpokenLanguageContentEnabled |
Determine whether receive original and translated is available.
| - (ZoomSDKError) isRequestToStartLiveTranscriptionEnabled |
Determine whether the request to start live transcription is enabled.
| - (BOOL) isTextLiveTranslationEnabled |
Determine whether the translated captions feature is enabled.
| - (ZoomSDKError) requestToStartLiveTranscription: | (BOOL) | bAnonymous |
Request the host to start ive transcription.
| bAnonymous | YES indicates the user anonymous request. |
| - (ZoomSDKError) saveCCHistory |
Save CC.
| - (ZoomSDKError) sendClosedCaptionMessage: | (NSString *) | ccString |
Send CC message.
| ccString | The content of CC. |
| - (ZoomSDKError) setMeetingSpokenLanguage: | (int) | languageID |
Set the spoken language of the current user.
| languageID | The spoken language id. |
| - (ZoomSDKError) setTranslationLanguage: | (int) | languageID |
Set the translation language of the current user.
| languageID | The translation language id. If the language ID is set to -1, live translation will be disabled. You can reveive closed captions if the host sets manual captions to true for the meeting. |
| - (ZoomSDKError) startLiveTranscription |
Start live transcription.
| - (ZoomSDKError) stopLiveTranscription |
Stop live transcription.
| - (ZoomSDKError) withdrawCCPriviledgeForUser: | (unsigned int) | userID |
This method is used for host to withdraw CC privilege from another user.
| userID | The ID of user that you want to withdraw CC privilege. |
|
protected |
Definition at line 82 of file ZoomSDKCloseCaptionController.h.
|
readwritenonatomicassign |
Definition at line 85 of file ZoomSDKCloseCaptionController.h.
1.9.6