Share via

TeamsCaptions Class

  • Reference
Package:
com.azure.android.communication.calling
  • java.lang.Object
    • CallCaptions
      • com.azure.android.communication.calling.TeamsCaptions

public class TeamsCaptions extends CallCaptions

Teams captions for managing captions for a Teams Interop call.

Method Summary

Modifier and Type Method and Description
void addOnActiveCaptionLanguageChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnActiveCaptionLanguageChanged events. ActiveCaptionLanguage Event. Occurs when caption language is changed.

void addOnActiveSpokenLanguageChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnActiveSpokenLanguageChanged events. ActiveSpokenLanguage Event. Occurs when spoken language is changed.

void addOnCaptionsEnabledChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnCaptionsEnabledChanged events. IsEnabled Event. Occurs when captions is started or stopped.

void addOnCaptionsReceivedListener(TeamsCaptionsListener listener)

Adds the specified listener to receive OnCaptionsReceived events. CaptionsReceived Event. Occurs when captions is received for a call.

String getActiveCaptionLanguage()

Get active caption language.

List<String> getSupportedCaptionLanguages()

List of supported captions languages for Captions.

void removeOnActiveCaptionLanguageChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnActiveCaptionLanguageChanged events. ActiveCaptionLanguage Event. Occurs when caption language is changed.

void removeOnActiveSpokenLanguageChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnActiveSpokenLanguageChanged events. ActiveSpokenLanguage Event. Occurs when spoken language is changed.

void removeOnCaptionsEnabledChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnCaptionsEnabledChanged events. IsEnabled Event. Occurs when captions is started or stopped.

void removeOnCaptionsReceivedListener(TeamsCaptionsListener listener)

Removes the specified listener to receive OnCaptionsReceived events. CaptionsReceived Event. Occurs when captions is received for a call.

CompletableFuture<Void> setCaptionLanguage(final String language)

Set the captions language.

Inherited Members

CallCaptions.finalize() CallCaptions.getActiveSpokenLanguage() CallCaptions.getCaptionsType() CallCaptions.getSupportedSpokenLanguages() CallCaptions.isEnabled() CallCaptions.setSpokenLanguage(final String language) CallCaptions.startCaptions(final StartCaptionsOptions options) CallCaptions.stopCaptions()

Method Details

addOnActiveCaptionLanguageChangedListener

public void addOnActiveCaptionLanguageChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnActiveCaptionLanguageChanged events. ActiveCaptionLanguage Event. Occurs when caption language is changed.

Parameters:

listener

addOnActiveSpokenLanguageChangedListener

public void addOnActiveSpokenLanguageChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnActiveSpokenLanguageChanged events. ActiveSpokenLanguage Event. Occurs when spoken language is changed.

Parameters:

listener

addOnCaptionsEnabledChangedListener

public void addOnCaptionsEnabledChangedListener(PropertyChangedListener listener)

Adds the specified listener to receive OnCaptionsEnabledChanged events. IsEnabled Event. Occurs when captions is started or stopped.

Parameters:

listener

addOnCaptionsReceivedListener

public void addOnCaptionsReceivedListener(TeamsCaptionsListener listener)

Adds the specified listener to receive OnCaptionsReceived events. CaptionsReceived Event. Occurs when captions is received for a call.

Parameters:

listener

getActiveCaptionLanguage

public String getActiveCaptionLanguage()

Get active caption language.

getSupportedCaptionLanguages

public List getSupportedCaptionLanguages()

List of supported captions languages for Captions.

removeOnActiveCaptionLanguageChangedListener

public void removeOnActiveCaptionLanguageChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnActiveCaptionLanguageChanged events. ActiveCaptionLanguage Event. Occurs when caption language is changed.

Parameters:

listener

removeOnActiveSpokenLanguageChangedListener

public void removeOnActiveSpokenLanguageChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnActiveSpokenLanguageChanged events. ActiveSpokenLanguage Event. Occurs when spoken language is changed.

Parameters:

listener

removeOnCaptionsEnabledChangedListener

public void removeOnCaptionsEnabledChangedListener(PropertyChangedListener listener)

Removes the specified listener to receive OnCaptionsEnabledChanged events. IsEnabled Event. Occurs when captions is started or stopped.

Parameters:

listener

removeOnCaptionsReceivedListener

public void removeOnCaptionsReceivedListener(TeamsCaptionsListener listener)

Removes the specified listener to receive OnCaptionsReceived events. CaptionsReceived Event. Occurs when captions is received for a call.

Parameters:

listener

setCaptionLanguage

public CompletableFuture setCaptionLanguage(final String language)

Set the captions language.

Parameters:

language

Applies to