ZMVideoSDKVoiceInterpretationHelper Class Reference

Provides methods for controlling and interacting with voice interpretation. More...

#include <ZMVideoSDKVoiceInterpretationHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isVoiceInterpretationEnabled
	Query whether voice interpretation capability is enabled in the current session.
(BOOL)	- isVoiceInterpretationReady
	Query whether voice interpretation is ready for use.
(BOOL)	- isVoiceInterpretationStarted
	Query whether voice interpretation has been started.
(ZMVideoSDKErrors)	- startVoiceInterpretation
	Start voice interpretation.
(ZMVideoSDKErrors)	- stopVoiceInterpretation
	Stop voice interpretation.
(ZMVideoSDKVoiceInterpretationLanguage *_Nullable)	- getMySpeakingLanguage
	Get the current speaking language for the local user.
(NSArray< ZMVideoSDKVoiceInterpretationLanguage * > *_Nullable)	- getMySpeakingLanguageList
	Get the available speaking language list.
(ZMVideoSDKErrors)	- setMySpeakingLanguage:
	Set the speaking language for the local user.
(ZMVideoSDKVoiceInterpretationLanguage *_Nullable)	- getTranslatedLanguage
	Get the current translated language for the local user.
(NSArray< ZMVideoSDKVoiceInterpretationLanguage * > *_Nullable)	- getTranslatedLanguagesList
	Get the available translated language list.
(ZMVideoSDKErrors)	- setTranslatedLanguage:
	Set the translated language for the local user.
(float)	- getAudioBalanceForOriginalAndTranslatedVoice
	Get the audio balance between original and translated voice.
(ZMVideoSDKErrors)	- setAudioBalanceForOriginalAndTranslatedVoice:
	Set the audio balance between original and translated voice.
(ZMVideoSDKVoiceInterpretationVoiceInfo *_Nullable)	- getTranslatedVoiceStyle
	Get the current translated voice style.
(NSArray< ZMVideoSDKVoiceInterpretationVoiceInfo * > *_Nullable)	- getTranslatedVoiceStyleList
	Get the available translated voice style list.
(ZMVideoSDKErrors)	- setTranslatedVoiceStyle:
	Set the translated voice style.

Detailed Description

Provides methods for controlling and interacting with voice interpretation.

Definition at line 49 of file ZMVideoSDKVoiceInterpretationHelper.h.

Method Documentation

getAudioBalanceForOriginalAndTranslatedVoice

- (float) getAudioBalanceForOriginalAndTranslatedVoice

Get the audio balance between original and translated voice.

Returns

Audio balance in the range [0.0, 1.0]. 0.0 means original only; 1.0 means translated only.

References getAudioBalanceForOriginalAndTranslatedVoice.

Referenced by getAudioBalanceForOriginalAndTranslatedVoice.

getMySpeakingLanguage

- (ZMVideoSDKVoiceInterpretationLanguage *_Nullable) getMySpeakingLanguage

Get the current speaking language for the local user.

Returns

The current speaking language, or nil if unavailable.

References getMySpeakingLanguage.

Referenced by getMySpeakingLanguage.

getMySpeakingLanguageList

- (NSArray< ZMVideoSDKVoiceInterpretationLanguage * > *_Nullable) getMySpeakingLanguageList

Get the available speaking language list.

Returns

The speaking language list, or nil if unavailable.

References getMySpeakingLanguageList.

Referenced by getMySpeakingLanguageList.

getTranslatedLanguage

- (ZMVideoSDKVoiceInterpretationLanguage *_Nullable) getTranslatedLanguage

Get the current translated language for the local user.

Returns

The current translated language, or nil if unavailable.

References getTranslatedLanguage.

Referenced by getTranslatedLanguage.

getTranslatedLanguagesList

- (NSArray< ZMVideoSDKVoiceInterpretationLanguage * > *_Nullable) getTranslatedLanguagesList

Get the available translated language list.

Returns

The translated language list, or nil if unavailable.

References getTranslatedLanguagesList.

Referenced by getTranslatedLanguagesList.

getTranslatedVoiceStyle

- (ZMVideoSDKVoiceInterpretationVoiceInfo *_Nullable) getTranslatedVoiceStyle

Get the current translated voice style.

Returns

The current voice style, or nil if unavailable.

References getTranslatedVoiceStyle.

Referenced by getTranslatedVoiceStyle.

getTranslatedVoiceStyleList

- (NSArray< ZMVideoSDKVoiceInterpretationVoiceInfo * > *_Nullable) getTranslatedVoiceStyleList

Get the available translated voice style list.

Returns

The translated voice style list, or nil if unavailable.

References getTranslatedVoiceStyleList.

Referenced by getTranslatedVoiceStyleList.

isVoiceInterpretationEnabled

- (BOOL) isVoiceInterpretationEnabled

Query whether voice interpretation capability is enabled in the current session.

Returns

YES if enabled; otherwise NO.

References isVoiceInterpretationEnabled.

Referenced by isVoiceInterpretationEnabled.

isVoiceInterpretationReady

- (BOOL) isVoiceInterpretationReady

Query whether voice interpretation is ready for use.

Returns

YES if ready; otherwise NO.

References isVoiceInterpretationReady.

Referenced by isVoiceInterpretationReady.

isVoiceInterpretationStarted

- (BOOL) isVoiceInterpretationStarted

Query whether voice interpretation has been started.

Returns

YES if started; otherwise NO.

References isVoiceInterpretationStarted.

Referenced by isVoiceInterpretationStarted.

setAudioBalanceForOriginalAndTranslatedVoice:

- (ZMVideoSDKErrors) setAudioBalanceForOriginalAndTranslatedVoice:

(float)

balance

Set the audio balance between original and translated voice.

Parameters

balance

Audio balance in the range [0.0, 1.0]. 0.0 means original only; 1.0 means translated only.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

setMySpeakingLanguage:

- (ZMVideoSDKErrors) setMySpeakingLanguage:

(ZMVideoSDKVoiceInterpretationLanguage *_Nullable)

language

Set the speaking language for the local user.

Parameters

language

The target speaking language.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

setTranslatedLanguage:

- (ZMVideoSDKErrors) setTranslatedLanguage:

(ZMVideoSDKVoiceInterpretationLanguage *_Nullable)

language

Set the translated language for the local user.

Parameters

language

The target translated language.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

setTranslatedVoiceStyle:

- (ZMVideoSDKErrors) setTranslatedVoiceStyle:

(ZMVideoSDKVoiceInterpretationVoiceInfo *_Nullable)

voiceInfo

Set the translated voice style.

Parameters

voiceInfo

The target voice style.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

startVoiceInterpretation

- (ZMVideoSDKErrors) startVoiceInterpretation

Start voice interpretation.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error. See ZMVideoSDKErrors.

References startVoiceInterpretation.

Referenced by startVoiceInterpretation.

stopVoiceInterpretation

- (ZMVideoSDKErrors) stopVoiceInterpretation

Stop voice interpretation.

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References stopVoiceInterpretation.

Referenced by stopVoiceInterpretation.