Mac Developer Library

Developer

IOVideoDevice Class Reference

Options
Deployment Target:

On This Page
Language:

IOVideoDevice

A class that represents a video device.

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable @import IOKit;

Availability


Available in OS X v10.7 and later.
  • Declaration

    C++

    virtual IOVideoStream* getStream( UInt32streamIndex);

    Parameters

    streamIndex

    The index for which the underlying stream is desired.

    Return Value

    Returns the number of streams of the device.

    Import Statement

  • Declaration

    C++

    virtual int getStreamCount( void);

    Return Value

    Returns the number of streams of the device.

    Import Statement

  • See the documentation for the IOService method newUserClient.

    Declaration

    C++

    virtual IOReturn newUserClient( task_t owningTask, void *securityID, UInt32 type, OSDictionary *properties, IOUserClient **handler);

    Import Statement

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

    Declaration

    C++

    virtual IOReturn setStreamMode( IOVideoStream *stream, IOStreamMode mode);

    Discussion

    This must be implemented by a subclass.

    Import Statement

  • Start sending data on a stream.

    Declaration

    C++

    virtual IOReturn startStream( IOVideoStream *stream);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully started.

    Discussion

    This must be implemented by a subclass.

    Import Statement

  • Stop sending data on a stream.

    Declaration

    C++

    virtual IOReturn stopStream( IOVideoStream *stream);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully started.

    Discussion

    This must be implemented by a subclass.

    Import Statement

  • Temporarily suspend data flow on the stream.

    Declaration

    C++

    virtual IOReturn suspendStream( IOVideoStream *stream);

    Return Value

    Returns kIOReturnSuccess if the stream was successfully suspended.

    Discussion

    This must be implemented by a subclass.

    Import Statement