diff options
Diffstat (limited to 'pjsip/include/pjsua-lib/pjsua.h')
| -rw-r--r-- | pjsip/include/pjsua-lib/pjsua.h | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index 8eeceed8..efdf9f4c 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -2529,27 +2529,32 @@ PJ_DECL(pj_status_t) pjsua_player_destroy(pjsua_player_id id); /** * Create a file recorder, and automatically connect this recorder to - * the conference bridge. + * the conference bridge. The recorder currently supports recording WAV file, + * and on Windows, MP3 file. The type of the recorder to use is determined + * by the extension of the file (e.g. ".wav" or ".mp3"). * * @param filename Output file name. The function will determine the * default format to be used based on the file extension. * Currently ".wav" is supported on all platforms, and * also ".mp3" is support on Windows. - * @param file_format This option is obsolete. - * @param encoding Optionally specify the encoding to be applied to the - * file. By default (if NULL is specified), the encoding - * is determined from the file extension (i.e. 16bit PCM - * is used for the WAV files). - * @param max_size Maximum file size. Specify -1 to remove size - * limitation. + * @param enc_type Optionally specify the type of encoder to be used to + * compress the media, if the file can support different + * encodings. This value must be zero for now. + * @param enc_param Optionally specify codec specific parameter to be + * passed to the file writer. For .MP3 recorder, this + * can point to pjmedia_mp3_encoder_option structure to + * specify additional settings for the .mp3 recorder. + * For .WAV recorder, this value must be NULL. + * @param max_size Maximum file size. Specify zero or -1 to remove size + * limitation. This value must be zero or -1 for now. * @param options Optional options. * @param p_id Pointer to receive the recorder instance. * * @return PJ_SUCCESS on success, or the appropriate error code. */ PJ_DECL(pj_status_t) pjsua_recorder_create(const pj_str_t *filename, - unsigned file_format, - const pj_str_t *encoding, + unsigned enc_type, + void *enc_param, pj_ssize_t max_size, unsigned options, pjsua_recorder_id *p_id); |