Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.MyNotesController Interface Reference

Interface of MyNotes controller APIs. More...

Public Member Functions

MobileRTCSDKError addListener (MyNotesListener listener)
 Adds the callback event handler for MyNotes.
boolean isMyNotesEnabled ()
 Determines whether the MyNotes feature is available. Checks that the user is signed in, the MyNotes feature is enabled by admin.
boolean canStartMyNotes ()
 Determines whether a MyNotes session can start right now. Checks runtime conditions: transcription is enabled in user settings, RECORD_AUDIO permission is granted, and MyNotes and in-meeting session are mutually exclusive, so this method returns false when a meeting is in progress.
MobileRTCSDKError showMyNotesView (Activity activity)
 Shows the MyNotes view. Launches the MyNotes user interface where the user can interact with the note session and view the transcription in real time. The caller should request RECORD_AUDIO permission before invoking this API.

Detailed Description

Interface of MyNotes controller APIs.

Definition at line 9 of file MyNotesController.java.

Member Function Documentation

◆ addListener()

MobileRTCSDKError us.zoom.sdk.MyNotesController.addListener ( MyNotesListener listener)

Adds the callback event handler for MyNotes.

Parameters
listenerThe event listener.
Returns
If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error code.

◆ canStartMyNotes()

boolean us.zoom.sdk.MyNotesController.canStartMyNotes ( )

Determines whether a MyNotes session can start right now. Checks runtime conditions: transcription is enabled in user settings, RECORD_AUDIO permission is granted, and MyNotes and in-meeting session are mutually exclusive, so this method returns false when a meeting is in progress.

Returns
true if a session can start. Otherwise, false.

◆ isMyNotesEnabled()

boolean us.zoom.sdk.MyNotesController.isMyNotesEnabled ( )

Determines whether the MyNotes feature is available. Checks that the user is signed in, the MyNotes feature is enabled by admin.

Returns
true if MyNotes is available. Otherwise, false.

◆ showMyNotesView()

MobileRTCSDKError us.zoom.sdk.MyNotesController.showMyNotesView ( Activity activity)

Shows the MyNotes view. Launches the MyNotes user interface where the user can interact with the note session and view the transcription in real time. The caller should request RECORD_AUDIO permission before invoking this API.

Parameters
activityThe current top activity.
Returns
If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error code.