Ocean
Ocean Media AVFoundation Library

The Ocean Media AVFoundation Library provides media functionalities based on Apple's AV Foundation framework. More...

Collaboration diagram for Ocean Media AVFoundation Library:

Data Structures

class  Ocean::Media::AVFoundation::AVFAudio
 This class implements an AVFoundation audio object. More...
 
class  Ocean::Media::AVFoundation::AVFDevices
 This class implements a simple enumerator for devices available via the AVFoundation library. More...
 
class  Ocean::Media::AVFoundation::AVFFrameMedium
 This is the base class for all AVFoundation frame mediums. More...
 
class  Ocean::Media::AVFoundation::AVFLibrary
 This class implements the AVFoundation library. More...
 
class  Ocean::Media::AVFoundation::AVFLiveAudio
 This class implements an AVFoundation live audio object. More...
 
class  Ocean::Media::AVFoundation::AVFLiveVideo
 This class implements a AVFoundation live video object. More...
 
class  Ocean::Media::AVFoundation::AVFMedium
 This is the base class for all AVFoundation mediums. More...
 
class  Ocean::Media::AVFoundation::AVFMicrophone
 This class implements an AVFoundation microphone object. More...
 
class  Ocean::Media::AVFoundation::AVFMovie
 This class implements an AVFoundation movie object. More...
 
class  Ocean::Media::AVFoundation::AVFMovieRecorder
 This class implements a AVFoundation movie recorder. More...
 
class  Ocean::Media::AVFoundation::PixelBufferAccessor
 This class allows to access a Core Video's CVPixelBuffer. More...
 

Typedefs

using Ocean::Media::AVFoundation::ScopedCVBufferRef = ScopedObjectCompileTimeVoidT< CVBufferRef, CVBufferRelease >
 Definition of a scoped object holding a CVBufferRef object. More...
 
using Ocean::Media::AVFoundation::ScopedCVPixelBufferRef = ScopedObjectCompileTimeT< CVPixelBufferRef, CVBufferRef, void, CVBufferRelease >
 Definition of a scoped object holding a CVPixelBufferRef object. More...
 
using Ocean::Media::AVFoundation::ScopedCMSampleBufferRef = ScopedObjectCompileTimeT< CMSampleBufferRef, CFTypeRef, void, CFRelease >
 Definition of a scoped object holding a CMSampleBufferRef object. More...
 

Functions

std::string Ocean::Media::AVFoundation::nameAVFLibrary ()
 Returns the name of this media AVFoundation library. More...
 
void Ocean::Media::AVFoundation::registerAVFLibrary ()
 Registers this media library at the global library manager. More...
 
bool Ocean::Media::AVFoundation::unregisterAVFLibrary ()
 Unregisters this media library at the global library manager. More...
 
bool pluginLoad ()
 Tries to load the plugin and initializes all internal 3rd party libraries. More...
 
bool pluginUnload ()
 Tries to unload the plugin and all internal resources of 3rd party libraries. More...
 

Detailed Description

The Ocean Media AVFoundation Library provides media functionalities based on Apple's AV Foundation framework.

The library is available on Apple platforms only.

Typedef Documentation

◆ ScopedCMSampleBufferRef

using Ocean::Media::AVFoundation::ScopedCMSampleBufferRef = typedef ScopedObjectCompileTimeT<CMSampleBufferRef, CFTypeRef, void, CFRelease>

Definition of a scoped object holding a CMSampleBufferRef object.

The wrapped CMSampleBufferRef object will be released automatically once the scoped object does not exist anymore.

◆ ScopedCVBufferRef

using Ocean::Media::AVFoundation::ScopedCVBufferRef = typedef ScopedObjectCompileTimeVoidT<CVBufferRef, CVBufferRelease>

Definition of a scoped object holding a CVBufferRef object.

The wrapped CVBufferRef object will be released automatically once the scoped object does not exist anymore.

◆ ScopedCVPixelBufferRef

using Ocean::Media::AVFoundation::ScopedCVPixelBufferRef = typedef ScopedObjectCompileTimeT<CVPixelBufferRef, CVBufferRef, void, CVBufferRelease>

Definition of a scoped object holding a CVPixelBufferRef object.

The wrapped CVPixelBufferRef object will be released automatically once the scoped object does not exist anymore.

Function Documentation

◆ nameAVFLibrary()

std::string Ocean::Media::AVFoundation::nameAVFLibrary ( )

Returns the name of this media AVFoundation library.

◆ pluginLoad()

bool pluginLoad ( )

Tries to load the plugin and initializes all internal 3rd party libraries.

Make sure that the plugin will be loaded only once!

Returns
True, if succeeded
See also
pluginUnload().

◆ pluginUnload()

bool pluginUnload ( )

Tries to unload the plugin and all internal resources of 3rd party libraries.

Make sure that all resources of this plugin has been released before!

Returns
True, if succeeded
See also
pluginLoad().

◆ registerAVFLibrary()

void Ocean::Media::AVFoundation::registerAVFLibrary ( )

Registers this media library at the global library manager.

This function calls AVFLibrary::registerLibrary() only.

◆ unregisterAVFLibrary()

bool Ocean::Media::AVFoundation::unregisterAVFLibrary ( )

Unregisters this media library at the global library manager.

This function calls AVFLibrary::unregisterLibrary() only.

Returns
True, if succeeded