Lumiera 0.pre.04~rc.1
»edit your freedom«
Loading...
Searching...
No Matches
MediaAccessFacade Class Reference

#include "vault/media-access-facade.hpp"

Description

Interface to the vault layer: provides functions for querying (opening) a media file, detecting the channels or streams found within this file etc.

Implementation delegating to the actual vault layer functions.

convention: data passed by pointer is owned by the originator; it should be copied if needed beyond the control flow of the invoked function.

Definition at line 57 of file media-access-facade.hpp.

Public Types

typedef void * ChanHandle
 

Static Public Attributes

static lib::Depend< MediaAccessFacadeinstance
 storage for the SingletonFactory (actually a lumiera::test::MockInjector)
 

Public Member Functions

virtual MediaDescqueryFile (string const &name) const
 request for testing the denoted files accessibility
 
virtual ChanDesc queryChannel (MediaDesc &, uint chanNo) const
 request for information about the n-th channel of the file referred by FileHandle.
 
virtual ~MediaAccessFacade ()
 

Constructor & Destructor Documentation

◆ ~MediaAccessFacade()

virtual ~MediaAccessFacade ( )
inlinevirtual

Definition at line 83 of file media-access-facade.hpp.

Member Typedef Documentation

◆ ChanHandle

typedef void* ChanHandle

Definition at line 60 of file media-access-facade.hpp.

Member Function Documentation

◆ queryFile()

MediaDesc & queryFile ( string const &  name) const
virtual

request for testing the denoted files accessibility

Parameters
namepath and filename of the media file.
Exceptions
error::Invalidwhen passing empty filename, or in case the media file is inaccessible or otherwise inappropriate.
Returns
opaque handle usable for querying channel information from this file, NULL if the file is not accessible.

Reimplemented in MediaAccessMock.

Definition at line 39 of file media-access-facade.cpp.

Referenced by MediaAccessMock_test::queryScenario().

+ Here is the caller graph for this function:

◆ queryChannel()

ChanDesc queryChannel ( MediaDesc mHandle,
uint  chanNo 
) const
virtual

request for information about the n-th channel of the file referred by FileHandle.

Returns
ChanDesc which may contain NULL values if the file doesn't contain this much channels.
Todo:
throw or return NULL-ChanDesc if Filehandle is invalid?

Reimplemented in MediaAccessMock.

Definition at line 49 of file media-access-facade.cpp.

Referenced by MediaAccessMock_test::queryScenario().

+ Here is the caller graph for this function:

Member Data Documentation

◆ instance

lib::Depend< MediaAccessFacade > instance
static

storage for the SingletonFactory (actually a lumiera::test::MockInjector)

Definition at line 62 of file media-access-facade.hpp.

Referenced by MediaAccessMock_test::queryScenario().

+ Inheritance diagram for MediaAccessFacade:
+ Collaboration diagram for MediaAccessFacade:

The documentation for this class was generated from the following files: