[Previous] [Contents] [Index] [Next]

PgCreateVideoChannel()

Create a channel for video streaming

Synopsis:

PgVideoChannel_t * PgCreateVideoChannel(
                      unsigned type,
                      unsigned flags );

Library:

ph

Description:

This function creates a channel to be used for video streaming, and reserves the video hardware for exclusive use by the application.

Currently, the only defined value for type is Pg_VIDEO_CHANNEL_SCALER. This specifies that the video channel is for outputting video frames using scaler hardware.

The possible values for flags include:

Pg_VIDEO_CHANNEL_FLAG_TARGETABLE
Allow the direction of Photon draw output to the video scaler buffer. Note that only RGB data format is supported for targeting in this manner.

Returns:

A pointer to a PgVideoChannel_t structure that describes a channel for subsequent video operations, or NULL if a video channel couldn't be created (errno is set).

Errors:

EBUSY
Scaler hardware is present, but is in use by another application.
ENXIO
No scaler hardware is present.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PgConfigScalerChannel(), PgDestroyVideoChannel(), PgGetOverlayChromaColor(), PgGetScalerCapabilities(), PgNextVideoFrame(), PgScalerCaps_t, PgScalerProps_t, PgVideoChannel_t

"Video overlay" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide


[Previous] [Contents] [Index] [Next]