OpenShot Library | libopenshot  0.2.2
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oNopenshotThis namespace is the default namespace for all code in the openshot library
|oCAudioBufferSourceThis class is used to expose an AudioSampleBuffer as an AudioSource in JUCE
|oCAudioDeviceManagerSingletonSingleton wrapper for AudioDeviceManager (to prevent multiple instances)
|oCAudioLocationThis struct holds the associated video frame and starting sample # for an audio packet
|oCAudioPlaybackThreadThe audio playback thread
|oCAudioReaderSourceThis class is used to expose any ReaderBase derived class as an AudioSource in JUCE
|oCAudioResamplerThis class is used to resample audio data for many sequential frames
|oCBarsThis class draws black bars around your video (from any side), and can be animated with openshot::Keyframe curves over time
|oCBaseExceptionBase exception class with a custom message variable
|oCBlurThis class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time
|oCBrightnessThis class adjusts the brightness and contrast of an image, and can be animated with openshot::Keyframe curves over time
|oCCacheBaseAll cache managers in libopenshot are based on this CacheBase class
|oCCacheDiskThis class is a disk-based cache manager for Frame objects
|oCCacheMemoryThis class is a memory-based cache manager for Frame objects
|oCChromaKeyThis class uses the ImageMagick++ libraries, to remove (i.e. key out) a color (i.e. greenscreen)
|oCChunkLocationThis struct holds the location of a frame within a chunk
|oCChunkNotFoundException when a required chunk is missing
|oCChunkReaderThis class reads a special chunk-formatted file, which can be easily shared in a distributed environment
|oCChunkWriterThis class takes any reader and generates a special type of video file, built with chunks of small video and audio data
|oCClipThis class represents a clip (used to arrange readers on the timeline)
|oCClipBaseThis abstract class is the base class, used by all clips in libopenshot
|oCColorThis class represents a color (used on the timeline and clips)
|oCColorShiftThis class shifts the pixels of an image up, down, left, or right, and can be animated with openshot::Keyframe curves over time
|oCCompareClipEffects
|oCCompareClips
|oCCompareEffects
|oCCoordinateThis class represents a Cartesian coordinate (X, Y) used in the Keyframe animation system
|oCCrashHandlerThis class is designed to catch exceptions thrown by libc (SIGABRT, SIGSEGV, SIGILL, SIGFPE)
|oCCropThis class crops a frame image (from any side), and can be animated with openshot::Keyframe curves over time
|oCDecklinkErrorException when accessing a blackmagic decklink card
|oCDecklinkReaderThis class uses the Blackmagic Decklink libraries, to open video streams on Blackmagic devices
|oCDecklinkWriterThis class uses the Blackmagic Decklink libraries, to send video streams to Blackmagic devices
|oCDeinterlaceThis class uses the ImageMagick++ libraries, to de-interlace the image, which removes the EVEN or ODD horizontal lines (which represent different points of time)
|oCDummyReaderThis class is used as a simple, dummy reader, which always returns a blank frame
|oCEffectBaseThis abstract class is the base class, used by all effects in libopenshot
|oCEffectInfoThis class returns a listing of all effects supported by libopenshot
|oCEffectInfoStructThis struct contains info about an effect, such as the name, video or audio effect, etc..
|oCErrorDecodingAudioException when decoding audio packet
|oCErrorEncodingAudioException when encoding audio packet
|oCErrorEncodingVideoException when encoding audio packet
|oCFFmpegReaderThis class uses the FFmpeg libraries, to open video files and audio files, and return openshot::Frame objects for any frame in the file
|oCFFmpegWriterThis class uses the FFmpeg libraries, to write and encode video files and audio files
|oCFieldThis struct holds a single field (half a frame)
|oCFractionThis class represents a fraction
|oCFrameThis class represents a single frame of video (i.e. image & audio data)
|oCFrameMapperThis class creates a mapping between 2 different frame rates, applying a specific pull-down technique
|oCHueThis class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time
|oCImageReaderThis class uses the ImageMagick++ libraries, to open image files, and return openshot::Frame objects containing the image
|oCImageWriterThis class uses the ImageMagick library to write image files (including animated GIFs)
|oCInvalidChannelsException when an invalid # of audio channels are detected
|oCInvalidCodecException when no valid codec is found for a file
|oCInvalidFileException for files that can not be found or opened
|oCInvalidFormatException when no valid format is found for a file
|oCInvalidJSONException for invalid JSON
|oCInvalidJSONKeyException for missing JSON Change key
|oCInvalidOptionsException when invalid encoding options are used
|oCInvalidSampleRateException when invalid sample rate is detected during encoding
|oCKeyframeA Keyframe is a collection of Point instances, which is used to vary a number or property over time
|oCMappedFrameThis struct holds two fields which together make up a complete video frame
|oCMaskThis class uses the ImageMagick++ libraries, to apply alpha (or transparency) masks to any frame. It can also be animated, and used as a powerful Wipe transition
|oCNegateThis class uses the ImageMagick++ libraries, to negate image (i.e. negative)
|oCNoStreamsFoundException when no streams are found in the file
|oCOpenShotVersionThis struct holds version number information. Use the GetVersion() method to access the current version of libopenshot
|oCOutOfBoundsFrameException for frames that are out of bounds
|oCOutOfBoundsPointException for an out of bounds key-frame point
|oCOutOfMemoryException when memory could not be allocated
|oCPixelateThis class pixelates an image, and can be animated with openshot::Keyframe curves over time
|oCPlayerBaseThis is the base class of all Players in libopenshot
|oCPlayerPrivateThe private part of QtPlayer class, which contains an audio thread and video thread, and controls the video timing and audio synchronization code
|oCPointA Point is the basic building block of a key-frame curve
|oCProfileThis class loads a special text-based file called a Profile
|oCProfileInfoThis struct holds profile data, typically loaded from a file
|oCQtImageReaderThis class uses the Qt library, to open image files, and return openshot::Frame objects containing the image
|oCQtPlayerThis class is used to playback a video from a reader
|oCReaderBaseThis abstract class is the base class, used by all readers in libopenshot
|oCReaderClosedException when a reader is closed, and a frame is requested
|oCReaderInfoThis struct contains info about a media file, such as height, width, frames per second, etc..
|oCRendererBaseThis is the base class of all Renderers in libopenshot
|oCResampleErrorException when resample fails
|oCSafeTimeSliceThread
|oCSampleRangeThis struct holds a the range of samples needed by this frame
|oCSaturationThis class adjusts the saturation of color on a frame's image
|oCShiftThis class shifts the pixels of an image up, down, left, or right, and can be animated with openshot::Keyframe curves over time
|oCTextReaderThis class uses the ImageMagick++ libraries, to create frames with "Text", and return openshot::Frame objects
|oCTimelineThis class represents a timeline
|oCTooManySeeksException when too many seek attempts happen
|oCVideoCacheThreadThe video cache class
|oCVideoPlaybackThreadThe video playback class
|oCWaveThis class distorts an image using a wave pattern
|oCWriterBaseThis abstract class is the base class, used by writers. Writers are types of classes that encode video, audio, and image files
|oCWriterClosedException when a writer is closed, and a frame is requested
|oCWriterInfoThis struct contains info about encoding a media file, such as height, width, frames per second, etc..
|\CZmqLoggerThis abstract class is the base class, used by all readers in libopenshot
oNOpenShot Wipe Tests
oCDeckLinkInputDelegateImplementation of the Blackmagic Decklink API (used by the DecklinkReader)
oCDeckLinkOutputDelegateImplementation of the Blackmagic Decklink API (used by the DecklinkWriter)
oCPlayerDemo
oCVideoRenderer
\CVideoRenderWidget