--- title: "Dictation" canonical_url: https://developer.repebble.com/docs/c/Foundation/Dictation/ last_updated: 2026-10-28 sdk_version: 4.33.1 --- # Dictation Source: https://developer.repebble.com/docs/c/Foundation/Dictation/ ## Function Documentation - [SDK 3](javascript:void(0);) - [SDK 4](javascript:void(0);) - [SDK 4.9+](javascript:void(0);) DictationSession \* dictation\_session\_create([uint32\_t](https://developer.repebble.com/docs/c/Standard_C.md#uint32_t) buffer\_size, [DictationSessionStatusCallback](https://developer.repebble.com/docs/c/Foundation/Dictation.md#DictationSessionStatusCallback) callback, void \* callback\_context) Create a dictation session. The session object can be used more than once to get a transcription. When a transcription is received a buffer will be allocated to store the text in with a maximum size specified by buffer\_size. When a transcription and accepted by the user or a failure of some sort occurs, the callback specified will be called with the status and the transcription if one was accepted. #### Parameters buffer\_size size of buffer to allocate for the transcription text; text will be truncated if it is longer than the maximum size specified; a size of 0 will allow the session to allocate as much as it needs and text will not be truncated callback dictation session status handler (must be valid) callback\_context context pointer for status handler #### Returns handle to the dictation session or NULL if the phone app is not connected or does not support voice dictation, if this is called on a platform that doesn't support voice dictation, or if an internal error occurs. DictationSession \* dictation\_session\_create([uint32\_t](https://developer.repebble.com/docs/c/Standard_C.md#uint32_t) buffer\_size, [DictationSessionStatusCallback](https://developer.repebble.com/docs/c/Foundation/Dictation.md#DictationSessionStatusCallback) callback, void \* callback\_context) Create a dictation session. The session object can be used more than once to get a transcription. When a transcription is received a buffer will be allocated to store the text in with a maximum size specified by buffer\_size. When a transcription and accepted by the user or a failure of some sort occurs, the callback specified will be called with the status and the transcription if one was accepted. #### Parameters buffer\_size size of buffer to allocate for the transcription text; text will be truncated if it is longer than the maximum size specified; a size of 0 will allow the session to allocate as much as it needs and text will not be truncated callback dictation session status handler (must be valid) callback\_context context pointer for status handler #### Returns handle to the dictation session or NULL if the phone app is not connected or does not support voice dictation, if this is called on a platform that doesn't support voice dictation, or if an internal error occurs. DictationSession \* dictation\_session\_create([uint32\_t](https://developer.repebble.com/docs/c/Standard_C.md#uint32_t) buffer\_size, [DictationSessionStatusCallback](https://developer.repebble.com/docs/c/Foundation/Dictation.md#DictationSessionStatusCallback) callback, void \* callback\_context) Create a dictation session. The session object can be used more than once to get a transcription. When a transcription is received a buffer will be allocated to store the text in with a maximum size specified by `buffer_size`. When a transcription is accepted by the user or a failure of some sort occurs, the callback specified will be called with the status and the transcription if one was accepted. #### Parameters buffer\_size size of buffer to allocate for the transcription text; text will be truncated if it is longer than the maximum size specified; a size of 0 will allow the session to allocate as much as it needs and text will not be truncated callback dictation session status handler (must be valid) callback\_context context pointer for status handler #### Returns handle to the dictation session or NULL if the phone app is not connected or does not support voice dictation, if this is called on a platform that doesn't support voice dictation, or if an internal error occurs. void dictation\_session\_destroy(DictationSession \* session) Destroy the dictation session and free its memory. Will terminate a session in progress. #### Parameters session dictation session to be destroyed [DictationSessionStatus](https://developer.repebble.com/docs/c/Foundation/Dictation.md#DictationSessionStatus) dictation\_session\_start(DictationSession \* session) Start the dictation session. The dictation UI will be shown. When the user accepts a transcription or exits the UI, or, when the confirmation dialog is disabled and a status is received, the status callback will be called. Can only be called when no session is in progress. The session can be restarted multiple times after the UI is exited or the session is stopped. #### Parameters session dictation session to start or restart #### Returns true if session was started, false if session is already in progress or is invalid. [DictationSessionStatus](https://developer.repebble.com/docs/c/Foundation/Dictation.md#DictationSessionStatus) dictation\_session\_stop(DictationSession \* session) Stop the current dictation session. The UI will be hidden and no status callbacks will be received after the session is stopped. #### Parameters session dictation session to stop #### Returns true if session was stopped, false if session was not started or is invalid void dictation\_session\_enable\_confirmation(DictationSession \* session, bool is\_enabled) Enable or disable user confirmation of transcribed text, which allows the user to accept or reject (and restart) the transcription. Must be called before the session is started. #### Parameters session dictation session to modify is\_enabled set to true to enable user confirmation of transcriptions (default), false to disable void dictation\_session\_enable\_error\_dialogs(DictationSession \* session, bool is\_enabled) Enable or disable error dialogs when transcription fails. Must be called before the session is started. Disabling error dialogs will also disable automatic retries if transcription fails. #### Parameters session dictation session to modify is\_enabled set to true to enable error dialogs (default), false to disable ## Enum Documentation enum DictationSessionStatus #### Enumerators DictationSessionStatusSuccess Transcription successful, with a valid result. DictationSessionStatusFailureTranscriptionRejected User rejected transcription and exited UI. DictationSessionStatusFailureTranscriptionRejectedWithError User exited UI after transcription error. DictationSessionStatusFailureSystemAborted Too many errors occurred during transcription and the UI exited. DictationSessionStatusFailureNoSpeechDetected No speech was detected and UI exited. DictationSessionStatusFailureConnectivityError No BT or internet connection. DictationSessionStatusFailureDisabled Voice transcription disabled for this user. DictationSessionStatusFailureInternalError Voice transcription failed due to internal error. DictationSessionStatusFailureRecognizerError Cloud recognizer failed to transcribe speech (only possible if error dialogs disabled) ## Typedef Documentation typedef struct DictationSession DictationSession typedef void(\* DictationSessionStatusCallback)(DictationSession \*session, DictationSessionStatus status, char \*transcription, void \*context) Dictation status callback. Indicates success or failure of the dictation session and, if successful, passes the transcribed string to the user of the dictation session. The transcribed string will be freed after this call returns, so the string should be copied if it needs to be retained afterwards. #### Parameters session dictation session from which the status was received status dictation status transcription transcribed string context callback context specified when starting the session ## Macro Definition Documentation - [SDK 3](javascript:void(0);) - [SDK 4](javascript:void(0);) - [SDK 4.9+](javascript:void(0);) #define PBL\_IF\_MICROPHONE\_ELSE ( if\_true, if\_false) Convenience macro to switch between two expressions depending on mic support. On platforms with a mic the first expression will be chosen, the second otherwise. #define PBL\_IF\_MICROPHONE\_ELSE ( if\_true, if\_false) Convenience macro to switch between two expressions depending on mic support. On platforms with a mic the first expression will be chosen, the second otherwise. #define PBL\_IF\_MICROPHONE\_ELSE ( if\_true, if\_false) Convenience macro to switch between two expressions depending on mic support. On platforms with a mic the first expression will be chosen, the second otherwise.