Ocean::Media::LiveMedium Class Reference
This class it the base class for all live mediums. More...
Inheritance diagram for Ocean::Media::LiveMedium:
Protected Member Functions | |
| LiveMedium (const std::string &url) | |
| Creates a new live medium by a given url. More... | |
 Protected Member Functions inherited from Ocean::Media::Medium | |
| Medium (const Medium &medium)=delete | |
| Disabled copy constructor. More... | |
| Medium (const std::string &url) | |
| Creates a new medium by a given url. More... | |
| virtual | ~Medium () |
| Destructs a medium. More... | |
| Medium & | operator= (const Medium &medium)=delete |
| Disabled copy operator. More... | |
| Protected Member Functions inherited from Ocean::Media::ConfigMedium | |
| ConfigMedium (const std::string &url) | |
| Creates a new ConfigMedium object by a given url. More... | |
Additional Inherited Members | |
| Public Types inherited from Ocean::Media::Medium | |
| enum | Type : uint32_t { MEDIUM = 0u , FRAME_MEDIUM = 1u << 0u , SOUND_MEDIUM = 1u << 1u , FINITE_MEDIUM = 1u << 2u , LIVE_MEDIUM = 1u << 3u , CONFIG_MEDIUM = 1u << 4u , AUDIO = (1u << 5u) | FINITE_MEDIUM | SOUND_MEDIUM , IMAGE = (1u << 6u) | FRAME_MEDIUM , PIXEL_IMAGE = (1u << 7u) | FRAME_MEDIUM , BUFFER_IMAGE = (1u << 8u) | FRAME_MEDIUM , IMAGE_SEQUENCE = (1u << 9u) | FRAME_MEDIUM | FINITE_MEDIUM , LIVE_AUDIO = (1u << 10u) | LIVE_MEDIUM | SOUND_MEDIUM , LIVE_VIDEO = (1u << 11u) | LIVE_MEDIUM | FRAME_MEDIUM , MICROPHONE = (1u << 12u) | LIVE_MEDIUM , MOVIE = (1u << 13u) | FINITE_MEDIUM | FRAME_MEDIUM | SOUND_MEDIUM } |
| Definition of different medium types. More... | |
| Public Types inherited from Ocean::Media::ConfigMedium | |
| typedef std::vector< std::string > | ConfigNames |
| Definition of a vector holding configuration names. More... | |
| Public Member Functions inherited from Ocean::Media::Medium | |
| const std::string & | url () const |
| Returns the url of the medium. More... | |
| bool | isValid () const |
| Returns whether the medium is valid. More... | |
| const std::string & | library () const |
| Returns the name of the owner library. More... | |
| Type | type () const |
| Returns the type of the medium. More... | |
| bool | isType (const Type type) const |
| Returns whether a medium has a given type. More... | |
| virtual bool | isStarted () const =0 |
| Returns whether the medium is started currently. More... | |
| bool | isExclusive () const |
| Returns whether this medium can be use exclusively. More... | |
| virtual bool | start ()=0 |
| Starts the medium. More... | |
| virtual bool | pause ()=0 |
| Pauses the medium. More... | |
| virtual bool | stop ()=0 |
| Stops the medium. More... | |
| virtual Timestamp | startTimestamp () const =0 |
| Returns the start timestamp. More... | |
| virtual Timestamp | pauseTimestamp () const =0 |
| Returns the pause timestamp. More... | |
| virtual Timestamp | stopTimestamp () const =0 |
| Returns the stop timestamp. More... | |
| virtual MediumRef | clone () const |
| Clones this medium and returns a new independent instance of this medium. More... | |
| Public Member Functions inherited from Ocean::Media::ConfigMedium | |
| virtual bool | configuration (const std::string &name, long long data) |
| Starts a configuration possibility. More... | |
| virtual ConfigNames | configs () const |
| Returns the names of the configuration possibilities. More... | |
| Static Public Member Functions inherited from Ocean::Media::Medium | |
| static std::string | convertType (const Type type) |
| Converts a medium type to a unique string. More... | |
| static Type | convertType (const std::string &type) |
| Converts a medium type string to a medium type. More... | |
| Protected Attributes inherited from Ocean::Media::Medium | |
| std::string | url_ |
| Url of the medium. More... | |
| std::string | libraryName_ |
| Name of the owner library. More... | |
| bool | isValid_ = false |
| Determines whether the medium is valid. More... | |
| Type | type_ = MEDIUM |
| Type of the medium. More... | |
| Lock | lock_ |
| Medium lock. More... | |
Detailed Description
This class it the base class for all live mediums.
Constructor & Destructor Documentation
◆ LiveMedium()
|
explicitprotected |
Creates a new live medium by a given url.
The documentation for this class was generated from the following file:
