mediastreamer2 5.2.0
Functions
Collaboration diagram for Sound Card Manager API:

Functions

MSSndCardManagerms_snd_card_manager_get (void)
 
MSFactoryms_snd_card_get_factory (MSSndCard *c)
 
MSSndCardManagerms_snd_card_manager_new (void)
 
void ms_snd_card_manager_destroy (MSSndCardManager *sndcardmanager)
 
void ms_snd_card_manager_set_param_string (MSSndCardManager *m, const char *paramString)
 
MSSndCardms_snd_card_manager_get_card (MSSndCardManager *m, const char *id)
 
MSSndCardms_snd_card_manager_get_card_with_capabilities (MSSndCardManager *m, const char *id, unsigned int capabilities)
 
MSSndCardms_snd_card_manager_get_card_by_type (MSSndCardManager *m, const MSSndCardDeviceType type, const char *driver_type)
 
MSSndCardms_snd_card_manager_get_playback_card (MSSndCardManager *m, const char *id)
 
bctbx_list_t * ms_snd_card_manager_get_all_cards_with_name (MSSndCardManager *m, const char *name)
 
MSSndCardms_snd_card_manager_get_capture_card (MSSndCardManager *m, const char *id)
 
MSSndCardms_snd_card_manager_get_default_card (MSSndCardManager *m)
 
MSSndCardms_snd_card_manager_get_default_capture_card (MSSndCardManager *m)
 
MSSndCardms_snd_card_manager_get_default_playback_card (MSSndCardManager *m)
 
const MSList * ms_snd_card_manager_get_list (MSSndCardManager *m)
 
void ms_snd_card_manager_add_card (MSSndCardManager *m, MSSndCard *c)
 
void ms_snd_card_manager_prepend_card (MSSndCardManager *m, MSSndCard *c)
 
void ms_snd_card_set_manager (MSSndCardManager *m, MSSndCard *c)
 
void ms_snd_card_manager_prepend_cards (MSSndCardManager *m, MSList *l)
 
void ms_snd_card_manager_register_desc (MSSndCardManager *m, MSSndCardDesc *desc)
 
void ms_snd_card_manager_unregister_desc (MSSndCardManager *m, MSSndCardDesc *desc)
 
void ms_snd_card_manager_reload (MSSndCardManager *m)
 
bool_t ms_snd_card_manager_reload_requested (MSSndCardManager *m)
 
bool_t ms_snd_card_is_card_duplicate (MSSndCardManager *m, MSSndCard *card, bool_t checkCapabilities)
 
MSSndCardms_snd_card_get_card_duplicate (MSSndCardManager *m, MSSndCard *card, bool_t checkCapabilities)
 
void ms_snd_card_remove_type_from_list_head (MSSndCardManager *m, MSSndCardDeviceType type)
 
bool_t ms_snd_card_manager_swap_cards (MSSndCardManager *m, MSSndCard *card0, MSSndCard *card1)
 
void ms_snd_card_manager_bypass_soundcard_detection (bool_t value)
 

Detailed Description

Function Documentation

◆ ms_snd_card_get_card_duplicate()

MSSndCard * ms_snd_card_get_card_duplicate ( MSSndCardManager m,
MSSndCard card,
bool_t  checkCapabilities 
)

Check if there is another card in the manager having same driver_type, name and device_type

Parameters
mCard Manager
cardCard to compare properties against
checkCapabilitiesflag to check capabilities

Returns: The duplicate if it is found, NULL otherwise

◆ ms_snd_card_get_factory()

MSFactory * ms_snd_card_get_factory ( MSSndCard c)

Retrieve a factory from a sound card object.

Parameters
cMSSndCard object. Returns: MSFactory pointer.

◆ ms_snd_card_is_card_duplicate()

bool_t ms_snd_card_is_card_duplicate ( MSSndCardManager m,
MSSndCard card,
bool_t  checkCapabilities 
)

Check if there is another card in the manager having same driver_type, name and device_type

Parameters
mCard Manager
cardCard to compare properties against
checkCapabilitiesflag to check capabilities

Returns: true if a duplicate has been found, false otherwise

◆ ms_snd_card_manager_add_card()

void ms_snd_card_manager_add_card ( MSSndCardManager m,
MSSndCard c 
)

Add a sound card object in a sound card manager's list.

Parameters
mA sound card manager containing sound cards.
cA sound card object.

◆ ms_snd_card_manager_destroy()

void ms_snd_card_manager_destroy ( MSSndCardManager sndcardmanager)

Destroy a sound card manager object. You usually do not need this function, the ms_factory_destroy() doing this job for you.

◆ ms_snd_card_manager_get()

MSSndCardManager * ms_snd_card_manager_get ( void  )

Retreive a sound card manager object.

Returns: MSSndCardManager if successfull, NULL otherwise.

Deprecated:
use ms_factory_get_snd_card_manager()

◆ ms_snd_card_manager_get_all_cards_with_name()

bctbx_list_t * ms_snd_card_manager_get_all_cards_with_name ( MSSndCardManager m,
const char *  name 
)

Retreive all sound cards having the name provided as input.

Parameters
mA sound card manager containing sound cards.
nameA name for card to search.

Returns: MSSndCard list of cards if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_capture_card()

MSSndCard * ms_snd_card_manager_get_capture_card ( MSSndCardManager m,
const char *  id 
)

Retreive a capture capable sound card object based on its name.

Parameters
mA sound card manager containing sound cards.
idA name for card to search.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_card()

MSSndCard * ms_snd_card_manager_get_card ( MSSndCardManager m,
const char *  id 
)

Retreive a sound card object based on it's id. The id can be a regex string. In this case, the search will be done on "Driver_type : ID." eg: "PulseAudio?( .*)?:.*Build in.*" will retrieve a card with an ID that contains "Build in" and use the PulseAudio Driver.

Parameters
mA sound card manager containing sound cards.
idAn id for card to search.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_card_by_type()

MSSndCard * ms_snd_card_manager_get_card_by_type ( MSSndCardManager m,
const MSSndCardDeviceType  type,
const char *  driver_type 
)

Retreive the first sound card object in the card manager based on its type and driver type.

Parameters
mA sound card manager containing sound cards.
driver_typeThe type of the driver.
typeThe type of the card.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_card_with_capabilities()

MSSndCard * ms_snd_card_manager_get_card_with_capabilities ( MSSndCardManager m,
const char *  id,
unsigned int  capabilities 
)

Retreive a sound card object based on it's id and capabilities. The id can be a regex string. In this case, the search will be done on "Filter : ID." eg: "PulseAudio?( .*)?:.*Build-in.*" will retrieve a card with an ID that contains "Build-in" in PulseAudio Filter.

Parameters
mA sound card manager containing sound cards.
idAn id for card to search.
capabilitiesA capabilities mask of MS_SND_CARD_CAP_PLAYBACK and/or MS_SND_CARD_CAP_CAPTURE

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_default_capture_card()

MSSndCard * ms_snd_card_manager_get_default_capture_card ( MSSndCardManager m)

Retreive the default capture sound card object.

Parameters
mA sound card manager containing sound cards.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_default_card()

MSSndCard * ms_snd_card_manager_get_default_card ( MSSndCardManager m)

Retreive the default sound card object.

Parameters
mA sound card manager containing sound cards.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_default_playback_card()

MSSndCard * ms_snd_card_manager_get_default_playback_card ( MSSndCardManager m)

Retreive the default playback sound card object.

Parameters
mA sound card manager containing sound cards.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_list()

const MSList * ms_snd_card_manager_get_list ( MSSndCardManager m)

Retreive the list of sound card objects.

Parameters
mA sound card manager containing sound cards.

Returns: MSList of cards if successfull, NULL otherwise.

◆ ms_snd_card_manager_get_playback_card()

MSSndCard * ms_snd_card_manager_get_playback_card ( MSSndCardManager m,
const char *  id 
)

Retreive a playback capable sound card object based on its name.

Parameters
mA sound card manager containing sound cards.
idA name for card to search.

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_new()

MSSndCardManager * ms_snd_card_manager_new ( void  )

Create a sound card manager object. You usually do not need this function, instead get the sound card manager from a factory with ms_factory_get_snd_card_manager().

◆ ms_snd_card_manager_prepend_card()

void ms_snd_card_manager_prepend_card ( MSSndCardManager m,
MSSndCard c 
)

Prepend a sound card object in a sound card manager's list.

Parameters
mA sound card manager containing sound cards.
cA sound card object.

◆ ms_snd_card_manager_prepend_cards()

void ms_snd_card_manager_prepend_cards ( MSSndCardManager m,
MSList *  l 
)

Prepend a list of sound card object to the sound card manager's list.

Parameters
[in]mA sound card manager containing sound cards.
[in]lA list of sound card objects to be prepended to the sound card manager's list.

◆ ms_snd_card_manager_register_desc()

void ms_snd_card_manager_register_desc ( MSSndCardManager m,
MSSndCardDesc desc 
)

Register a sound card description in a sound card manager.

Parameters
mA sound card manager containing sound cards.
descA sound card description object.

◆ ms_snd_card_manager_reload()

void ms_snd_card_manager_reload ( MSSndCardManager m)

Ask all registered MSSndCardDesc to re-detect their soundcards.

Parameters
mThe sound card manager.

◆ ms_snd_card_manager_reload_requested()

bool_t ms_snd_card_manager_reload_requested ( MSSndCardManager m)

Check if the manager reload is requested. Specific for iOS: sometimes auido routes add/remove devices when there are no calls. In this case, the manager reload is requested to update devices.

Parameters
mCard Manager Returns: true if the manager reload is requested.

◆ ms_snd_card_manager_set_param_string()

void ms_snd_card_manager_set_param_string ( MSSndCardManager m,
const char *  paramString 
)

Set the sound card manager's parameter string

Parameters
mA sound card manager.
paramStringA string of the form "param1=true;param2=42;param3=false"

Returns: MSSndCard if successfull, NULL otherwise.

◆ ms_snd_card_manager_swap_cards()

bool_t ms_snd_card_manager_swap_cards ( MSSndCardManager m,
MSSndCard card0,
MSSndCard card1 
)

Swap two position of 2 sound cards in the sound card manager.

Parameters
mCard Manager
card0Card to be swapped
card1Card to be swapped

Returns: true if card0 and card1 are not null and both are found among the list of sound cards in the card manager, false otherwise

◆ ms_snd_card_manager_unregister_desc()

void ms_snd_card_manager_unregister_desc ( MSSndCardManager m,
MSSndCardDesc desc 
)

Unregister a sound card description in a sound card manager.

Parameters
mA sound card manager containing sound cards.
descA sound card description object.

◆ ms_snd_card_remove_type_from_list_head()

void ms_snd_card_remove_type_from_list_head ( MSSndCardManager m,
MSSndCardDeviceType  type 
)

Prevent card type to be at the head fo the list

Parameters
mCard Manager
typeCard type to remove from the head of list of cards

◆ ms_snd_card_set_manager()

void ms_snd_card_set_manager ( MSSndCardManager m,
MSSndCard c 
)

Set the sound card manager of a sound card.

Parameters
mA sound card manager containing sound cards.
cA sound card object.