diff options
| author | Nanang Izzuddin <nanang@teluu.com> | 2008-09-11 17:38:48 +0000 |
|---|---|---|
| committer | Nanang Izzuddin <nanang@teluu.com> | 2008-09-11 17:38:48 +0000 |
| commit | 0413bbf70ebb13b2c17168bcf75eb12b271b4efd (patch) | |
| tree | 1365d0e9b0ed770f63df8e5952e57dfd883c3a01 /pjmedia | |
| parent | 031dbfeb687f0b5c0433e506de74ec4e59ac536b (diff) | |
Ticket #614: Updated docs related to support for play/record G.711 U-law/A-law.
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@2275 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjmedia')
| -rw-r--r-- | pjmedia/include/pjmedia/wav_port.h | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/pjmedia/include/pjmedia/wav_port.h b/pjmedia/include/pjmedia/wav_port.h index 1e133f16..31745544 100644 --- a/pjmedia/include/pjmedia/wav_port.h +++ b/pjmedia/include/pjmedia/wav_port.h @@ -51,7 +51,9 @@ enum pjmedia_file_player_option /** - * Create a media port to play streams from a WAV file. + * Create a media port to play streams from a WAV file. WAV player port + * supports for reading WAV file with uncompressed 16 bit PCM format or + * compressed G.711 A-law/U-law format. * * @param pool Pool to create memory buffers for this port. * @param filename File name to open. @@ -168,6 +170,9 @@ enum pjmedia_file_writer_option * Create a media port to record streams to a WAV file. Note that the port * must be closed properly (with #pjmedia_port_destroy()) so that the WAV * header can be filled with correct values (such as the file length). + * WAV writer port supports for writing audio in uncompressed 16 bit PCM format + * or compressed G.711 U-law/A-law format, this needs to be specified in + * \a flags param. * * @param pool Pool to create memory buffers for this port. * @param filename File name. @@ -175,11 +180,12 @@ enum pjmedia_file_writer_option * @param channel_count Number of channels. * @param samples_per_frame Number of samples per frame. * @param bits_per_sample Number of bits per sample (eg 16). - * @param flags Port creation flags. + * @param flags Port creation flags, see + * #pjmedia_file_writer_option. * @param buff_size Buffer size to be allocated. If the value is * zero or negative, the port will use default buffer * size (which is about 4KB). - * @param p_port Pointer to receive the file port instance. + * @param p_port Pointer to receive the file port instance. * * @return PJ_SUCCESS on success. */ |