mmr_output_parameters()

Set output parameters.

Synopsis:

#include <mm/renderer/renderer.h>
 
int mmr_output_parameters(mmr_context_t *ctxt,
                          unsigned output_id,
                          strm_dict_t *parms)

Since:

BlackBerry 10.0.0

Arguments:

ctxt

A context handle.

output_id

An output ID.

parms

A dictionary object containing the parameters to set (must not be NULL). Any previous parameters are overridden. The strm_dict_t object becomes API property after this call, even if the call fails. You should not use or destroy the dictionary after passing it to this function.

Library:

libmmrndclient (For the qcc command, use the -l mrndclient option to link against this library)

Description:

Set parameters for an output device. The acceptable parameter values depend on the plugins loaded for the attached output and the attached input, if any. Unlike input and track parameters, the values of output parameters won't be changed by mm-renderer plugins. If the provided values aren't supported for the current output and input combination, the function call fails.

The output type determines which output parameters you can set. At present, there are no output parameters for the "file" output type.

For the "audio" output type, the following parameter is available for any URL format:

volume

Set the volume for this audio stream. The volume must be an integer in decimal format in the range of 0 to 100.

When using the "audio" output type with a URL that starts with audio:, you can set one of the following two parameters:

audio_type

Specifies the audio type to use with the track. The audio type is specified as a string that's set to one of the audio types defined by AUDIO_TYPE_NAMES, which is documented in the Audio Manager Library reference. Acceptable values include "multimedia" and "notification"; consult the Audio Manager for the complete list of defined audio types and their meanings.

This parameter provides a shortcut for setting the audio type, thereby simplifying your client code. You can use this parameter instead of using the Audio Manager API to obtain an audio manager handle, and then using that handle to set the audio type.

audioman_handle

Associate an audio manager handle with the audio stream that the current context manages. To obtain a value for this parameter, call the audio_manager_get_handle() API function and pass in the desired audio type.

You can then use this handle to change the audio type and other audio stream characteristics through the Audio Manager API. For more information, refer to the audio routing functions described in the Audio Manager Library reference.

For the "video" output type, your application should modify the output window directly by using the libscreen library, as demonstrated in "Managing video windows".

Note: The legacy video output parameters video_dest_*, video_src_*, and video_clip_* have been deprecated. Using libscreen is the proper way to configure video output.

The mmr_output_attach() function sets the parameters url and type. Some plugins allow you to modify the URL with mmr_output_parameters(). For instance, you can ask mm-renderer to switch output devices by calling mmr_output_parameters() with a new URL in the parameters.

Returns:

Zero on success, -1 on failure (use mmr_error_info()).

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus