My Project
Public Attributes
MMAL_PORT_T Struct Reference

#include <mmal_port.h>

List of all members.

Public Attributes

struct MMAL_PORT_PRIVATE_Tpriv
const char * name
MMAL_PORT_TYPE_T type
uint16_t index
uint16_t index_all
uint32_t is_enabled
MMAL_ES_FORMAT_Tformat
uint32_t buffer_num_min
uint32_t buffer_size_min
uint32_t buffer_alignment_min
uint32_t buffer_num_recommended
uint32_t buffer_size_recommended
uint32_t buffer_num
uint32_t buffer_size
struct MMAL_COMPONENT_Tcomponent
struct MMAL_PORT_USERDATA_T * userdata
uint32_t capabilities

Detailed Description

Definition of a port. A port is the entity that is exposed by components to receive or transmit buffer headers (MMAL_BUFFER_HEADER_T). A port is defined by its MMAL_ES_FORMAT_T.

It may be possible to override the buffer requirements of a port by using the MMAL_PARAMETER_BUFFER_REQUIREMENTS parameter.


Member Data Documentation

Minimum alignment requirement for the buffers (Read Only). A value of zero means no special alignment requirements. This is set by the component.

Actual number of buffers the port will use. This is set by the client.

Minimum number of buffers the port requires (Read Only). This is set by the component.

Number of buffers the port recommends for optimal performance (Read Only). A value of zero means no special recommendation. This is set by the component.

Actual maximum size of the buffers that will be sent to the port. This is set by the client.

Minimum size of buffers the port requires (Read Only). This is set by the component.

Size of buffers the port recommends for optimal performance (Read Only). A value of zero means no special recommendation. This is set by the component.

Flags describing the capabilities of a port (Read Only). Bitwise combination of Port capabilities values.

Component this port belongs to (Read Only)

Format of the elementary stream

Index of the port in its type list (Read Only)

Index of the port in the list of all ports (Read Only)

Indicates whether the port is enabled or not (Read Only)

const char* MMAL_PORT_T::name

Port name. Used for debugging purposes (Read Only)

Private member used by the framework

Type of the port (Read Only)

struct MMAL_PORT_USERDATA_T* MMAL_PORT_T::userdata

Field reserved for use by the client


The documentation for this struct was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines