My Project
Public Attributes | List of all members
MMAL_PORT_T Struct Reference
Ports

#include <mmal_port.h>

Public Attributes

struct MMAL_PORT_PRIVATE_T * priv
 
const char * name
 
MMAL_PORT_TYPE_T type
 
uint16_t index
 
uint16_t index_all
 
uint32_t is_enabled
 
MMAL_ES_FORMAT_T * format
 
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_T * component
 
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.

Definition at line 79 of file mmal_port.h.

Member Data Documentation

◆ buffer_alignment_min

uint32_t MMAL_PORT_T::buffer_alignment_min

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

Definition at line 95 of file mmal_port.h.

◆ buffer_num

uint32_t MMAL_PORT_T::buffer_num

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

Definition at line 104 of file mmal_port.h.

◆ buffer_num_min

uint32_t MMAL_PORT_T::buffer_num_min

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

Definition at line 91 of file mmal_port.h.

◆ buffer_num_recommended

uint32_t MMAL_PORT_T::buffer_num_recommended

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.

Definition at line 98 of file mmal_port.h.

◆ buffer_size

uint32_t MMAL_PORT_T::buffer_size

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

Definition at line 106 of file mmal_port.h.

◆ buffer_size_min

uint32_t MMAL_PORT_T::buffer_size_min

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

Definition at line 93 of file mmal_port.h.

◆ buffer_size_recommended

uint32_t MMAL_PORT_T::buffer_size_recommended

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.

Definition at line 101 of file mmal_port.h.

◆ capabilities

uint32_t MMAL_PORT_T::capabilities

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

Definition at line 112 of file mmal_port.h.

◆ component

struct MMAL_COMPONENT_T* MMAL_PORT_T::component

Component this port belongs to (Read Only)

Definition at line 109 of file mmal_port.h.

◆ format

MMAL_ES_FORMAT_T* MMAL_PORT_T::format

Format of the elementary stream

Definition at line 89 of file mmal_port.h.

◆ index

uint16_t MMAL_PORT_T::index

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

Definition at line 85 of file mmal_port.h.

◆ index_all

uint16_t MMAL_PORT_T::index_all

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

Definition at line 86 of file mmal_port.h.

◆ is_enabled

uint32_t MMAL_PORT_T::is_enabled

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

Definition at line 88 of file mmal_port.h.

◆ name

const char* MMAL_PORT_T::name

Port name. Used for debugging purposes (Read Only)

Definition at line 82 of file mmal_port.h.

◆ priv

struct MMAL_PORT_PRIVATE_T* MMAL_PORT_T::priv

Private member used by the framework

Definition at line 81 of file mmal_port.h.

◆ type

MMAL_PORT_TYPE_T MMAL_PORT_T::type

Type of the port (Read Only)

Definition at line 84 of file mmal_port.h.

◆ userdata

struct MMAL_PORT_USERDATA_T* MMAL_PORT_T::userdata

Field reserved for use by the client

Definition at line 110 of file mmal_port.h.

The documentation for this struct was generated from the following file: