/home/jvcleave/Desktop/RASPBERRY_PI/userland/interface/mmal/util/mmal_util_params.h File Reference

#include "interface/mmal/mmal.h"

Go to the source code of this file.

Functions
MMAL_STATUS_T	mmal_port_parameter_set_boolean (MMAL_PORT_T *port, uint32_t id, MMAL_BOOL_T value)
MMAL_STATUS_T	mmal_port_parameter_get_boolean (MMAL_PORT_T *port, uint32_t id, MMAL_BOOL_T *value)
MMAL_STATUS_T	mmal_port_parameter_set_uint64 (MMAL_PORT_T *port, uint32_t id, uint64_t value)
MMAL_STATUS_T	mmal_port_parameter_get_uint64 (MMAL_PORT_T *port, uint32_t id, uint64_t *value)
MMAL_STATUS_T	mmal_port_parameter_set_int64 (MMAL_PORT_T *port, uint32_t id, int64_t value)
MMAL_STATUS_T	mmal_port_parameter_get_int64 (MMAL_PORT_T *port, uint32_t id, int64_t *value)
MMAL_STATUS_T	mmal_port_parameter_set_uint32 (MMAL_PORT_T *port, uint32_t id, uint32_t value)
MMAL_STATUS_T	mmal_port_parameter_get_uint32 (MMAL_PORT_T *port, uint32_t id, uint32_t *value)
MMAL_STATUS_T	mmal_port_parameter_set_int32 (MMAL_PORT_T *port, uint32_t id, int32_t value)
MMAL_STATUS_T	mmal_port_parameter_get_int32 (MMAL_PORT_T *port, uint32_t id, int32_t *value)
MMAL_STATUS_T	mmal_port_parameter_set_rational (MMAL_PORT_T *port, uint32_t id, MMAL_RATIONAL_T value)
MMAL_STATUS_T	mmal_port_parameter_get_rational (MMAL_PORT_T *port, uint32_t id, MMAL_RATIONAL_T *value)
MMAL_STATUS_T	mmal_port_parameter_set_string (MMAL_PORT_T *port, uint32_t id, const char *value)
MMAL_STATUS_T	mmal_port_parameter_set_bytes (MMAL_PORT_T *port, uint32_t id, const uint8_t *data, unsigned int size)
MMAL_STATUS_T	mmal_util_port_set_uri (MMAL_PORT_T *port, const char *uri)
MMAL_STATUS_T	mmal_util_set_display_region (MMAL_PORT_T *port, MMAL_DISPLAYREGION_T *region)
MMAL_STATUS_T	mmal_util_camera_use_stc_timestamp (MMAL_PORT_T *port, MMAL_CAMERA_STC_MODE_T mode)
MMAL_STATUS_T	mmal_util_get_core_port_stats (MMAL_PORT_T *port, MMAL_CORE_STATS_DIR dir, MMAL_BOOL_T reset, MMAL_CORE_STATISTICS_T *stats)

---

Detailed Description

Utility functions to set some common parameters.

---

Function Documentation

MMAL_STATUS_T mmal_port_parameter_get_boolean	(	MMAL_PORT_T *	port,
		uint32_t	id,
		MMAL_BOOL_T *	value
	)

Helper function to get the value of a boolean parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a boolean parameter

MMAL_STATUS_T mmal_port_parameter_get_int32	(	MMAL_PORT_T *	port,
		uint32_t	id,
		int32_t *	value
	)

Helper function to get the value of a 32 bits signed integer parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a 32 bits signed integer parameter

MMAL_STATUS_T mmal_port_parameter_get_int64	(	MMAL_PORT_T *	port,
		uint32_t	id,
		int64_t *	value
	)

Helper function to get the value of a 64 bits signed integer parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a 64 bits signed integer parameter

MMAL_STATUS_T mmal_port_parameter_get_rational	(	MMAL_PORT_T *	port,
		uint32_t	id,
		MMAL_RATIONAL_T *	value
	)

Helper function to get the value of a rational parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a rational parameter

MMAL_STATUS_T mmal_port_parameter_get_uint32	(	MMAL_PORT_T *	port,
		uint32_t	id,
		uint32_t *	value
	)

Helper function to get the value of a 32 bits unsigned integer parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a 32 bits unsigned integer parameter

MMAL_STATUS_T mmal_port_parameter_get_uint64	(	MMAL_PORT_T *	port,
		uint32_t	id,
		uint64_t *	value
	)

Helper function to get the value of a 64 bits unsigned integer parameter.

Parameters:

port	port on which to get the parameter
id	parameter id
value	pointer to where the value will be returned

Returns:

MMAL_SUCCESS or error

Helper function to get the value of a 64 bits unsigned integer parameter

MMAL_STATUS_T mmal_port_parameter_set_boolean	(	MMAL_PORT_T *	port,
		uint32_t	id,
		MMAL_BOOL_T	value
	)

Helper function to set the value of a boolean parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a boolean parameter

MMAL_STATUS_T mmal_port_parameter_set_bytes	(	MMAL_PORT_T *	port,
		uint32_t	id,
		const uint8_t *	data,
		unsigned int	size
	)

Helper function to set the value of an array of bytes parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
data	pointer to the array of bytes
size	size of the array of bytes

Returns:

MMAL_SUCCESS or error

Helper function to set the value of an array of bytes parameter

MMAL_STATUS_T mmal_port_parameter_set_int32	(	MMAL_PORT_T *	port,
		uint32_t	id,
		int32_t	value
	)

Helper function to set the value of a 32 bits signed integer parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a 32 bits signed integer parameter

MMAL_STATUS_T mmal_port_parameter_set_int64	(	MMAL_PORT_T *	port,
		uint32_t	id,
		int64_t	value
	)

Helper function to set the value of a 64 bits signed integer parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a 64 bits signed integer parameter

MMAL_STATUS_T mmal_port_parameter_set_rational	(	MMAL_PORT_T *	port,
		uint32_t	id,
		MMAL_RATIONAL_T	value
	)

Helper function to set the value of a rational parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a rational parameter

MMAL_STATUS_T mmal_port_parameter_set_string	(	MMAL_PORT_T *	port,
		uint32_t	id,
		const char *	value
	)

Helper function to set the value of a string parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	null-terminated string value

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a string parameter

MMAL_STATUS_T mmal_port_parameter_set_uint32	(	MMAL_PORT_T *	port,
		uint32_t	id,
		uint32_t	value
	)

Helper function to set the value of a 32 bits unsigned integer parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a 32 bits unsigned integer parameter

MMAL_STATUS_T mmal_port_parameter_set_uint64	(	MMAL_PORT_T *	port,
		uint32_t	id,
		uint64_t	value
	)

Helper function to set the value of a 64 bits unsigned integer parameter.

Parameters:

port	port on which to set the parameter
id	parameter id
value	value to set the parameter to

Returns:

MMAL_SUCCESS or error

Helper function to set the value of a 64 bits unsigned integer parameter

MMAL_STATUS_T mmal_util_camera_use_stc_timestamp	(	MMAL_PORT_T *	port,
		MMAL_CAMERA_STC_MODE_T	mode
	)

Tell the camera to use the STC for timestamps rather than the clock.

Parameters:

port	port to configure
mode	STC mode to use

Returns:

MMAL_SUCCESS or error

MMAL_STATUS_T mmal_util_get_core_port_stats	(	MMAL_PORT_T *	port,
		MMAL_CORE_STATS_DIR	dir,
		MMAL_BOOL_T	reset,
		MMAL_CORE_STATISTICS_T *	stats
	)

Get the MMAL core statistics for a given port.

Parameters:

port	port to query
dir	port direction
reset	reset the stats as well
stats	filled in with results

Returns:

MMAL_SUCCESS or error

MMAL_STATUS_T mmal_util_port_set_uri	(	MMAL_PORT_T *	port,
		const char *	uri
	)

Helper function to set a MMAL_PARAMETER_URI_T parameter on a port.

Parameters:

port	port on which to set the parameter
uri	URI string

Returns:

MMAL_SUCCESS or error

Helper function to set a MMAL_PARAMETER_URI_T parameter on a port

MMAL_STATUS_T mmal_util_set_display_region	(	MMAL_PORT_T *	port,
		MMAL_DISPLAYREGION_T *	region
	)

Set the display region.

Parameters:

port	port to configure
region	region

Returns:

MMAL_SUCCESS or error