Mac Developer Library

Developer

IOVideoStream Class Reference

Options
Deployment Target:

On This Page
Language:

IOVideoStream

A class representing a stream of video data buffers passed from kernel to user space and back again. More...

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable @import IOKit;

Availability


Available in OS X v10.7 and later.
  • Returns the mode of the stream, either input or output.

    Declaration

    C++

    virtual IOStreamMode getStreamMode( void);

    Return Value

    The mode of the stream, either kIOStreamModeInput (from user space to kernel space) or the default kIOStreamModeOutput (from kernel space to user space).

    Import Statement

  • Declaration

    C++

    virtual bool initWithBuffers( OSArray *buffers, IOStreamMode mode = kIOStreamModeOutput, IOItemCount queueLength = 0, OSDictionary *properties = 0);

    Parameters

    buffers

    An array of IOStreamBuffer objects which will be the buffers for this stream.

    mode

    The initial mode of the video stream, either output, input, or input/output.

    queueLength

    The nuber of queue entries to reserve in the input and output queue. Zero means to make the queues big enough to accommodate all the buffers at once.

    properties

    A dictionary of properties which will be set on the video stream.

    Import Statement

  • Sets the mode of the stream, either input or output.

    Declaration

    C++

    virtual IOReturn setStreamMode( IOStreamMode mode);

    Import Statement

  • Start sending data on a stream.

    Declaration

    C++

    virtual IOReturn startStream( void);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully started.

    Import Statement

  • Stop sending data on a stream.

    Declaration

    C++

    virtual IOReturn stopStream( void);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully started.

    Import Statement

  • Temporarily suspend data flow on the stream.

    Declaration

    C++

    virtual IOReturn suspendStream( void);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully suspended.

    Import Statement

  • Declaration

    C++

    static IOVideoStream* withBuffers( OSArray *buffers, IOStreamMode mode = kIOStreamModeOutput, IOItemCount queueLength = 0, OSDictionary *properties = 0);

    Parameters

    buffers

    An array of IOStreamBuffer objects which will be the buffers for this stream.

    mode

    The initial mode of the video stream, either output, input, or input/output.

    queueLength

    The nuber of queue entries to reserve in the input and output queue. Zero means to make the queues big enough to accommodate all the buffers at once.

    properties

    A dictionary of properties which will be set on the video stream.

    Import Statement