mm_video_properties_t

Video display properties

Synopsis:

#include <mm/types.h>

typedef struct mm_video_properties {
    uint32_t   flags;
    struct {
        uint32_t  left,top,right,bottom;
    } source;
    struct {
        uint32_t  left,top,right,bottom;
    } dest;
    uint32_t   frame_width;
    uint32_t   frame_height;
    uint32_t   frame_buffers;
    uint32_t   display_mode;
} mm_video_properties_t;

Description:

The structure mm_video_properties_t describes video display properties. It includes at least the members described in the table below.

Member Type Description
flags uint32_t Flags indicating how to handle the video display.
source struct The rectangle (left and top inclusive; right and bottom exclusive) to extract from the source video; must be within the width and height dimensions given by mme_video_get_info(); it is ignored if MM_AUTO_SCALE is set.
dest struct The rectangle (left and top inclusive; right and bottom exclusive) to render the video into; it must be within the frame_width and frame_height dimensions given by mme_video_get_info(); it is ignored if MM_AUTO_SCALE is set.
frame_width uint32_t Specify the width, in pixels, of the video surface to use when rendering a video; it does not imply scaling (the frame may or may not be completely filled by the rendered video); it is used only if the MM_SET_VID_FRAME_SIZE flag is set.
frame_height uint32_t Specify the height, in pixels, of the video surface to use when rendering a video; it does not imply scaling (the frame may or may not be completely filled by the rendered video); it is used only if the MM_SET_VID_FRAME_SIZE flag is set.
frame_buffers uint32_t Specify the number of video frames to buffer; must be less than or equal to max_bufferable_frames given by mme_video_get_info(); it is only used if the MM_SET_FRAME_BUFFERS flag is set.
display_mode uint32_t The video display mode; used only if the MM_SET_DISPLAY_MODE flag is set.

For more information about video dimensions and aspect ratio see mm_video_info_t.


Note: Currently io-media-generic only supports setting the video source and destination (the source and dest members of the mm_video_properties_t structure). Other io-media variants may support other capabilities.

left, top, right and bottom

The left, top, right and bottom members of the structures source and dest define, respectively, the video source and destination video rectangles, in pixels. The left and top values are inclusive; the right and bottom values are exclusive.

flags

The flags member of the structure mm_video_properties_t uses the following values:

Classification:

QNX Multimedia

See also:

mm_audio_format_t, mm_audio_type, mm_bitrate_t, mme_video_audio_info_t, mme_video_info_t, mme_audio_get_status, mme_video_get_status(), mme_video_get_info(), mme_video_set_properties()