WARNING: The online documentation has moved to https://docs.pjsip.org.

Visit the new documentation at https://docs.pjsip.org:

BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJMEDIA Reference

AMRCodec wrapper for OpenCORE AMR codec. More...

Data Structures

struct  pjmedia_codec_amr_config
 

Typedefs

typedef pjmedia_codec_amr_config pjmedia_codec_amrnb_config
 
typedef pjmedia_codec_amr_config pjmedia_codec_amrwb_config
 

Enumerations

enum  pjmedia_amr_options {
  PJMEDIA_AMR_NO_NB = 1 ,
  PJMEDIA_AMR_NO_WB = 2
}
 

Functions

pj_status_t pjmedia_codec_opencore_amr_init (pjmedia_endpt *endpt, unsigned options)
 
pj_status_t pjmedia_codec_opencore_amr_init_default (pjmedia_endpt *endpt)
 
pj_status_t pjmedia_codec_opencore_amr_deinit (void)
 
pj_status_t pjmedia_codec_opencore_amrnb_init (pjmedia_endpt *endpt)
 
pj_status_t pjmedia_codec_opencore_amrnb_deinit (void)
 
pj_status_t pjmedia_codec_opencore_amrnb_set_config (const pjmedia_codec_amrnb_config *cfg)
 
pj_status_t pjmedia_codec_opencore_amrwb_set_config (const pjmedia_codec_amrwb_config *cfg)
 

Detailed Description

Enumeration Type Documentation

◆ pjmedia_amr_options

Bitmask options to be passed during AMR codec factory initialization.

Enumerator
PJMEDIA_AMR_NO_NB 

Disable narrowband mode.

PJMEDIA_AMR_NO_WB 

Disable wideband mode.

Function Documentation

◆ pjmedia_codec_opencore_amr_init()

pj_status_t pjmedia_codec_opencore_amr_init ( pjmedia_endpt endpt,
unsigned  options 
)

Initialize and register AMR codec factory to pjmedia endpoint.

Parameters
endptThe pjmedia endpoint.
optionsBitmask of pjmedia_amr_options (default=0).
Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amr_init_default()

pj_status_t pjmedia_codec_opencore_amr_init_default ( pjmedia_endpt endpt)

Initialize and register AMR codec factory using default settings to pjmedia endpoint.

Parameters
endptThe pjmedia endpoint.
Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amr_deinit()

pj_status_t pjmedia_codec_opencore_amr_deinit ( void  )

Unregister AMR codec factory from pjmedia endpoint and deinitialize the OpenCORE codec library.

Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amrnb_init()

pj_status_t pjmedia_codec_opencore_amrnb_init ( pjmedia_endpt endpt)

Initialize and register AMR-NB codec factory to pjmedia endpoint. Calling this function will automatically initialize AMR codec factory without the wideband mode (i.e. it is equivalent to calling pjmedia_codec_opencore_amr_init() with PJMEDIA_AMR_NO_WB). Application should call pjmedia_codec_opencore_amr_init() instead if wishing to use both modes.

Parameters
endptThe pjmedia endpoint.
Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amrnb_deinit()

pj_status_t pjmedia_codec_opencore_amrnb_deinit ( void  )

Unregister AMR-NB codec factory from pjmedia endpoint and deinitialize the OpenCORE codec library.

Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amrnb_set_config()

pj_status_t pjmedia_codec_opencore_amrnb_set_config ( const pjmedia_codec_amrnb_config cfg)

Set AMR-NB parameters.

Parameters
cfgThe settings;
Returns
PJ_SUCCESS on success.

◆ pjmedia_codec_opencore_amrwb_set_config()

pj_status_t pjmedia_codec_opencore_amrwb_set_config ( const pjmedia_codec_amrwb_config cfg)

Set AMR-WB parameters.

Parameters
cfgThe settings;
Returns
PJ_SUCCESS on success.

 


PJMEDIA small footprint Open Source media stack
Copyright (C) 2006-2008 Teluu Inc.