AVBlocks for C++  1.9
Audio and Video Software Development Kit
Classes | Namespaces | Enumerations | Functions | Variables
AVBlocks.h File Reference

Classes

class  ErrorInfo
 Describes an AVBlocks error. More...
class  Parameter
 Parameter is the base class for named parameters passed to various classes in AVBlocks. More...
class  ByteArrayParameter
 The parameter represents a byte array (buffer). More...
class  MediaBufferParameter
 The parameter represents a MediaBuffer object. More...
class  StringParameter
 The parameter represents an untyped value which is stored in a char_t string. More...
class  IntParameter
 The parameter represents a 64-bit integer. More...
class  FloatParameter
 The parameter represents a 64-bit floating point number (double precision). More...
class  ParameterList
 A collection of Parameter objects. More...
class  MediaInfo
 Analyzes a file or a stream and provides information about its type and properties. More...
class  MediaPin
 MediaPin represents an elementary media stream. More...
class  MediaPinList
 MediaPinList represents the elementary pins within a MediaSocket object. More...
class  MediaSocket
 An input or output point of the Transcoder. More...
class  MediaSocketList
 MediaSocketList represents the inputs or outputs of a Transcoder. More...
class  TranscoderCallback
 The TranscoderCallback provides a way to receive notifications from the Transcoder and also to control its operation while it is running (Transcoder::run). More...
class  Transcoder
 Provides functionality for audio and video encoding, decoding and transforming. More...

Namespaces

namespace  primo
 

Top namespace for all libraries developed by Primo Software Corp.


namespace  primo::avblocks
 

AVBlocks Application Programming Interface.


namespace  primo::avblocks::ErrorFacility
 

Describes the AVBlocks facilities that could generate errors.


namespace  primo::avblocks::AVBlocksError
 

Defines API usage errors.


namespace  primo::avblocks::TranscoderError
 

Defines Transcoder specific errors.


namespace  primo::avblocks::MediaInfoError
 

Defines MediaInfo specific errors.


namespace  primo::avblocks::DemuxerError
 

Defines errors generated by a demuxer block during a de-multiplexing operation.


namespace  primo::avblocks::MuxerError
 

Defines errors generated by a muxer block during a multiplexing operation.


namespace  primo::avblocks::CodecError
 

Defines errors generated by a codec block.


namespace  primo::avblocks::StreamError
 

Defines errors related to operations on streams.


namespace  primo::avblocks::PinConnection
 

These constants are used as special values of MediaPin.ID.


namespace  primo::avblocks::Use
 

Specifies whether particular feature should be used.


namespace  primo::avblocks::Param
 

Defines parameters that can be passed to the transcoder and to the components that are used in the transcoding process.


namespace  primo::avblocks::Param::Video
 

Parameters specific to video filter processing.


namespace  primo::avblocks::Param::Video::FrameRateConverter
 

Parameters specific to video frame rate processing.


namespace  primo::avblocks::Param::Video::Deinterlacing
 

Parameters specific to video deinterlacing.


namespace  primo::avblocks::Param::Video::Resize
 

Parameters specific to video resizing.


namespace  primo::avblocks::Param::Video::Crop
 

Parameters specific to video cropping.


namespace  primo::avblocks::Param::Video::Pad
 

Parameters specific to video padding.


namespace  primo::avblocks::Param::Decoder
 

Parameters specific to decoders.


namespace  primo::avblocks::Param::Decoder::Video
 

Parameters specific to video decoders.


namespace  primo::avblocks::Param::Decoder::Video::H264
 

Parameters specific to H.264 decoders.


namespace  primo::avblocks::Param::Decoder::Video::H264::VUI
 

Parameters the are part of the Video Usability Information in the H.264 stream.


namespace  primo::avblocks::Param::Encoder
 

Parameters specific to encoders.


namespace  primo::avblocks::Param::Encoder::Audio
 

Parameters specific to audio encoders.


namespace  primo::avblocks::Param::Encoder::Audio::MPEG1
 

Parameters specific to MPEG1 audio encoders.


namespace  primo::avblocks::Param::Encoder::Audio::Vorbis
 

Parameters specific to Vorbis audio encoders.


namespace  primo::avblocks::Param::Encoder::Audio::WMA
 

Parameters specific to WMA audio encoders.


namespace  primo::avblocks::Param::Encoder::Video
 

Parameters specific to video encoders.


namespace  primo::avblocks::Param::Encoder::Video::MPEG2
 

Parameters specific to MPEG2 video encoders.


namespace  primo::avblocks::Param::Encoder::Video::H264
 

Parameters specific to H.264 encoders.


namespace  primo::avblocks::Param::Muxer
 

Parameters specific to muxers.


namespace  primo::avblocks::Param::Muxer::MP4
 

Parameters specific to MP4 muxers.


namespace  primo::avblocks::ParamType
 

The ParamType represents the type of the data stored in a Parameter.


namespace  primo::avblocks::Preset
 

Defines output presets supported by AVBlocks.


namespace  primo::avblocks::Quality
 

An approximate indicator of audio/video quality.


namespace  primo::avblocks::TranscoderStatus
 

Defines the status of a transcoder operation.


namespace  primo::avblocks::Library
 

Initializes AVBlocks and manages license information.


Enumerations

enum  Enum {
  Success = 0,
  SystemWindows = 1,
  SystemMacOSStatus = 2,
  SystemMacMach = 3,
  SystemPosix = 4,
  AVBlocks = 5,
  Transcoder = 6,
  Demuxer = 7,
  Muxer = 8,
  Codec = 9,
  MediaInfo = 10,
  Stream = 11,
  Block = 12
}
 ErrorFacility::Enum. More...
enum  Enum {
  Failed = 1,
  NullPointer = 2,
  InvalidParams = 3,
  Alloc = 4,
  NotImplemented = 5,
  InvalidOperation = 6,
  UnsupportedFormat = 7,
  MissingDependency = 8,
  UnlicensedFeature = 9
}
 AVBlocksError::Enum. More...
enum  Enum {
  NoChain = 1,
  UndefinedSocketType = 2,
  UnsupportedInterlacedConversion = 3,
  NoCodec = 4,
  UnsupportedVideoConversion = 5,
  BufferFull = 6,
  InputNeeded = 7
}
 TranscoderError::Enum. More...
enum  Enum { NoInput = 1 }
 MediaInfoError::Enum. More...
enum  Enum {
  Open = 1,
  Read = 2
}
 DemuxerError::Enum. More...
enum  Enum {
  Open = 1,
  Write = 2,
  Stop = 3
}
 MuxerError::Enum. More...
enum  Enum {
  Open = 1,
  NoConfigData = 2,
  NoOutput = 3,
  OutputBufferNotEnough = 4,
  UnsupportedCodecProfile = 5
}
 Codec Error. More...
enum  Enum {
  Open = 1,
  Read = 2,
  Write = 3,
  Seek = 4,
  EOS = 5
}
 StreamError::Enum. More...
enum  Enum {
  Disabled = -1,
  Auto = 0
}
 PinConnection::Enum. More...
enum  Enum {
  Off = 0,
  On = 1,
  Auto = 2
}
enum  Enum {
  Float = 1,
  ByteArray = 2,
  MediaBuffer = 3,
  VideoStreamInfo = 4,
  String = 5,
  Int = 6
}
 ParamType::Enum. More...
enum  Enum {
  None = 0,
  DVD_PAL_MP2 = 1,
  DVD_PAL_WIDE_MP2 = 2,
  DVD_NTSC_PCM = 3,
  DVD_NTSC_MP2 = 4,
  DVD_NTSC_WIDE_PCM = 5,
  DVD_NTSC_WIDE_MP2 = 6,
  AAC = 7,
  AppleTv_H264 = 8,
  AppleTv_MPEG4 = 9,
  AudioCD = 10,
  MP4_H264 = 11,
  iPad_H264 = 12,
  iPad_H264_HD = 13,
  iPad_MPEG4 = 14,
  Apple_LiveStreaming = 15,
  iPhone_H264 = 16,
  iPhone_MPEG4 = 17,
  iPod_H264 = 18,
  iPod_MPEG4 = 19,
  M4A = 20,
  MP2_DVD = 21,
  MP3 = 22,
  MPEG1 = 23,
  WebM = 24,
  Android_Phone_H264 = 25,
  Android_Tablet_H264 = 26,
  Android_Tablet_H264_HD = 27,
  WMA_Standard = 28,
  WMA_Professioal = 29,
  WMA_Lossless = 30,
  OggVorbis = 31
}
 Output presets supported by AVBlocks. More...
enum  Enum {
  Normal = 0,
  Low = 1,
  High = 2
}
 Quality::Enum. More...
enum  Enum { Completed = 0 }
 TranscoderStatus::Enum. More...

Functions

AVBLOCKS_API bool_t AVBLOCKS_CALL avb_initialize ()
 Initializes the AVBlocks library.
AVBLOCKS_API void AVBLOCKS_CALL avb_shutdown ()
 Closes the AVBlocks library and frees the resources that are used (if any).
AVBLOCKS_API int32_t AVBLOCKS_CALL avb_set_license (const char *license)
 Sets a license string.
AVBLOCKS_API
primo::license::LicenseInfo
*AVBLOCKS_CALL 		avb_create_license_info ()
 Creates a new LicenseInfo instance.
AVBLOCKS_API
primo::avblocks::Transcoder
*AVBLOCKS_CALL 		avb_create_transcoder ()
 Creates a Transcoder.
AVBLOCKS_API
primo::codecs::AudioStreamInfo
*AVBLOCKS_CALL 		avb_create_audio_stream_info ()
 Creates an empty audio stream info.
AVBLOCKS_API
primo::codecs::VideoStreamInfo
*AVBLOCKS_CALL 		avb_create_video_stream_info ()
 Creates an empty video stream info.
AVBLOCKS_API
primo::codecs::MediaSample
*AVBLOCKS_CALL 		avb_create_media_sample ()
 Creates an empty media sample.
AVBLOCKS_API
primo::codecs::MediaBuffer
*AVBLOCKS_CALL 		avb_create_media_buffer (int32_t capacity)
 Creates a media buffer with the specified capacity.
AVBLOCKS_API
primo::avblocks::MediaPin
*AVBLOCKS_CALL 		avb_create_media_pin ()
 Creates a media pin.
AVBLOCKS_API
primo::avblocks::MediaSocket
*AVBLOCKS_CALL 		avb_create_media_socket ()
 Creates a media socket.
AVBLOCKS_API
primo::avblocks::MediaSocket
*AVBLOCKS_CALL 		avb_create_media_socket_from_media_info (primo::avblocks::MediaInfo *)
 Creates a media socket from a MediaInfo object.
AVBLOCKS_API
primo::avblocks::MediaSocket
*AVBLOCKS_CALL 		avb_create_media_socket_from_preset (primo::avblocks::Preset::Enum, primo::avblocks::Quality::Enum)
 Creates a media socket from an AVBlocks Preset.
AVBLOCKS_API
primo::avblocks::MediaInfo
*AVBLOCKS_CALL 		avb_create_media_info ()
 Creates a media information object.
AVBLOCKS_API
primo::avblocks::ByteArrayParameter
*AVBLOCKS_CALL 		avb_create_byte_array_parameter ()
 Creates a parameter that represents a byte array.
AVBLOCKS_API
primo::avblocks::MediaBufferParameter
*AVBLOCKS_CALL 		avb_create_media_buffer_parameter ()
 Creates a parameter that holds a MediaBuffer object.
AVBLOCKS_API
primo::avblocks::StringParameter
*AVBLOCKS_CALL 		avb_create_string_parameter ()
 Creates a parameter that holds a char_t* string.
AVBLOCKS_API
primo::avblocks::IntParameter
*AVBLOCKS_CALL 		avb_create_int_parameter ()
 Creates an integer parameter.
AVBLOCKS_API
primo::avblocks::FloatParameter
*AVBLOCKS_CALL 		avb_create_float_parameter ()
 Creates a float parameter.
AVBLOCKS_API
primo::avblocks::ParameterList
*AVBLOCKS_CALL 		avb_create_parameter_list ()
 Creates an empty collection of filter parameters.
AVBLOCKS_API
primo::codecs::Metadata
*AVBLOCKS_CALL 		avb_create_metadata ()
 Creates an empty Metadata object.
AVBLOCKS_API
primo::codecs::MetaAttribute
*AVBLOCKS_CALL 		avb_create_meta_attribute ()
 Creates an empty MetaAttribute object.
AVBLOCKS_API
primo::codecs::MetaPicture
*AVBLOCKS_CALL 		avb_create_meta_picture ()
 Creates an empty MetaPicture object.
bool_t initialize ()
 see avb_initialize
void shutdown ()
 see avb_shutdown
int32_t setLicense (const char *license)
 see avb_set_license
primo::license::LicenseInfo * createLicenseInfo ()
 see avb_create_license_info
Transcoder * createTranscoder ()
 see avb_create_transcoder
primo::codecs::AudioStreamInfo * createAudioStreamInfo ()
 see avb_create_audio_stream_info
primo::codecs::VideoStreamInfo * createVideoStreamInfo ()
 see avb_create_video_stream_info
primo::codecs::MediaSample * createMediaSample ()
 see avb_create_media_sample
primo::codecs::MediaBuffer * createMediaBuffer (int32_t capacity)
 see avb_create_media_buffer
primo::avblocks::MediaPin * createMediaPin ()
 see avb_create_media_pin
primo::avblocks::MediaSocket * createMediaSocket ()
 see avb_create_media_socket
primo::avblocks::MediaInfo * createMediaInfo ()
 see avb_create_media_info
primo::avblocks::ByteArrayParameter * createByteArrayParameter ()
 see avb_create_byte_array_parameter
primo::avblocks::MediaBufferParameter * createMediaBufferParameter ()
 see avb_create_media_buffer_parameter
primo::avblocks::StringParameter * createStringParameter ()
 see avb_create_string_parameter
primo::avblocks::IntParameter * createIntParameter ()
 see avb_create_int_parameter
primo::avblocks::FloatParameter * createFloatParameter ()
 see avb_create_float_parameter
primo::avblocks::ParameterList * createParameterList ()
 see avb_create_parameter_list
primo::codecs::Metadata * createMetadata ()
 see avb_create_metadata
primo::codecs::MetaAttribute * createMetaAttribute ()
 see avb_create_meta_attribute
primo::codecs::MetaPicture * createMetaPicture ()
 see avb_create_meta_picture

Variables

static const char Use [] = "VIDEO_FRAME_RATE_FILTER"
 Video: Specifies whether a video frame rate filter is inserted in the processing chain.
static const char Method [] = "DEINTERLACING_METHOD"
 Video: Specifies the deinterlacing method used by the deinterlacing filter.
static const char Threshold [] = "DEINTERLACING_THRESHOLD"
 Video: Specifies the deinterlacing threshold that is used by some deinterlacing methods.
static const char Use [] = "DEINTERLACING_FILTER"
static const char InterpolationMethod [] = "RESIZE_INTERPOLATION_METHOD"
 Video: Specifies the interpolation method that is used for resizing video frames.
static const char Left [] = "CROP_LEFT"
 Video: Specifies the area to be cropped inside the left edge of the input frame.
static const char Right [] = "CROP_RIGHT"
 Video: Specifies the area to be cropped inside the right edge of the input frame.
static const char Top [] = "CROP_TOP"
 Video: Specifies the area to be cropped inside the top edge of the input frame.
static const char Bottom [] = "CROP_BOTTOM"
 Video: Specifies the area to be cropped inside the bottom edge of the input frame.
static const char Left [] = "PAD_LEFT"
 Video: Specifies the area to be padded inside the left edge of the output frame.
static const char Right [] = "PAD_RIGHT"
 Video: Specifies the area to be padded inside the right edge of the output frame.
static const char Top [] = "PAD_TOP"
 Video: Specifies the area to be padded inside the top edge of the output frame.
static const char Bottom [] = "PAD_BOTTOM"
 Video: Specifies the area to be padded inside the bottom edge of the output frame.
static const char Color [] = "PAD_COLOR"
 Video: Specifies the padding color if any padding is set.
static const char Config [] = "DECODER_CONFIG"
 Decoder configuration data.
static const char MaxDecFrameBuffering [] = "DECODER_H264_MAX_DEC_FRAME_BUFFERING"
 H264 Video: Specifies the requested size of the Decoded Picture Buffer.
static const char ConcealDefects [] = "DECODER_VIDEO_CONCEAL_DEFECTS"
 Video: Specifies whether to conceal bitstream defects and errors.
static const char ForceV1 [] = "ENCODER_MPEGAUDIO_FORCE_V1"
 MPEG Audio: Forces MPEG audio to version 1.
static const char Quality [] = "ENCODER_VORBIS_QUALITY"
 Vorbis Audio: Specifies the quality of the compressed audio.
static const char Quality [] = "ENCODER_WMA_QUALITY"
 Windows Media Audio: Specifies the quality of the compressed audio.
static const char Codec [] = "ENCODER_WMA_CODEC_ID"
 Windows Media Audio: Specifies the WMA codec identifier.
static const int Lossless = 1
 Windows Media Audio Lossless Codec.
static const int Professional = 2
 Windows Media Audio Professional Codec.
static const int Standard = 3
 Windows Media Audio Standard Codec.
static const char GOPSize [] = "ENCODER_MPEG2VIDEO_GOPSIZE"
 MPEG-2 Video: Size of the Group Of Pictures (GOP).
static const char Profile [] = "ENCODER_H264_PROFILE_IDC"
 H.264 Video: Encoding profile.
static const char EntropyCodingMode [] = "ENCODER_H264_ENTROPY_CODING_MODE"
 H.264 Video: Entropy coding mode.
static const char NumBFrames [] = "ENCODER_H264_NUM_B_FRAMES"
 H.264 Video: Number of B-pictures between consequent I-pictures or P-pictures.
static const char TreatBFramesAsReference [] = "ENCODER_H264_TREAT_B_FRAMES_AS_REFERENCE"
 H.264 Video: Allows B-pictures to be used as reference pictures.
static const char NumRefFrames [] = "ENCODER_H264_NUM_REF_FRAMES"
 H.264 Video: Maximum number of reference pictures.
static const char NumSlices [] = "ENCODER_H264_NUM_SLICES"
 H.264 Video: Number of slices per frame/field.
static const char Level [] = "ENCODER_H264_LEVEL_IDC"
 H.264 Video: Computation level.
static const char DeblockingFilter [] = "ENCODER_H264_DEBLOCKING_FILTER_IDC"
 H.264 Video: De-blocking filter mode.
static const char DeblockingFilterAlpha [] = "ENCODER_H264_DEBLOCKING_FILTER_ALPHA"
 H.264 Video: De-blocking filter strength.
static const char DeblockingFilterBeta [] = "ENCODER_H264_DEBLOCKING_FILTER_BETA"
 H.264 Video: De-blocking filter threshold.
static const char Transform8x8 [] = "ENCODER_H264_TRANSFORM8X8"
 H.264 Video: Enables 8x8 transform block size.
static const char DirectPredMode [] = "ENCODER_H264_DIRECT_PRED_MODE"
 H.264 Video: Direct prediction mode.
static const char QualitySpeed [] = "ENCODER_H264_QUALITY_SPEED"
 H.264 Video: Quality/Speed trade off.
static const char MERangeSearchX [] = "ENCODER_H264_ME_RANGE_SEARCH_X"
 H.264 Video: Specifies how far motion estimation should be done in a horizontal direction.
static const char MERangeSearchY [] = "ENCODER_H264_ME_RANGE_SEARCH_Y"
 H.264 Video: Specifies how far motion estimation should be done in a vertical direction.
static const char MESplitMode [] = "ENCODER_H264_ME_SPLIT_MODE"
 H.264 Video: Specifies the block size for which motion estimation should be done.
static const char MEMethod [] = "ENCODER_H264_ME_METHOD"
 H.264 Video: Motion estimation method.
static const char PictureCodingType [] = "ENCODER_H264_PIC_CODING_TYPE"
 H.264 Video: Picture coding type.
static const char RateControlMethod [] = "ENCODER_H264_RATE_CONTROL_METHOD"
 H.264 Video: Rate control method.
static const char RateControlQuantI [] = "ENCODER_H264_RATE_CONTROL_QUANT_I"
 H.264 Video: Rate control quantizer for I slices.
static const char RateControlQuantP [] = "ENCODER_H264_RATE_CONTROL_QUANT_P"
 H.264 Video: Rate control quantizer for P slices.
static const char RateControlQuantB [] = "ENCODER_H264_RATE_CONTROL_QUANT_B"
 H.264 Video: Rate control quantizer for B slices.
static const char KeyFrameInterval [] = "ENCODER_H264_KEY_FRAME_INTERVAL"
 H.264 Video: Distance between two sequential I-pictures.
static const char KeyFrameIDRInterval [] = "ENCODER_H264_KEY_FRAME_IDR_INTERVAL"
 H.264 Video: Distance between two sequential IDR-pictures in terms of I pictures.
static const char FastStart [] = "MUXER_MP4_FAST_START"
 Run a second pass moving the moov atom before the mdat atom.
static const char FastStartUseTempFile [] = "MUXER_MP4_FAST_START_USE_TEMP_FILE"
 Specifies whether a temp file will to be used during the second pass.
static const char FastStartTempFileDirectory [] = "MUXER_MP4_FAST_START_TEMP_FILE_DIRECTORY"
 Specifies the temp file directory.

Detailed Description

Function Documentation

AVBLOCKS_API primo::codecs::AudioStreamInfo* AVBLOCKS_CALL avb_create_audio_stream_info ( )

Creates an empty audio stream info.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new AudioStreamInfo object.
See also:
Object Management
AudioStreamInfo

Referenced by primo::avblocks::Library::createAudioStreamInfo().

AVBLOCKS_API primo::avblocks::ByteArrayParameter* AVBLOCKS_CALL avb_create_byte_array_parameter ( )

Creates a parameter that represents a byte array.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Parameter object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createByteArrayParameter().

AVBLOCKS_API primo::avblocks::FloatParameter* AVBLOCKS_CALL avb_create_float_parameter ( )

Creates a float parameter.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Parameter object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createFloatParameter().

AVBLOCKS_API primo::avblocks::IntParameter* AVBLOCKS_CALL avb_create_int_parameter ( )

Creates an integer parameter.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Parameter object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createIntParameter().

AVBLOCKS_API primo::license::LicenseInfo* AVBLOCKS_CALL avb_create_license_info ( )

Creates a new LicenseInfo instance.

Version:
1.2.0
Returns:
A pointer to LicenseInfo object.
See also:
primo::license::LicenseInfo

Referenced by primo::avblocks::Library::createLicenseInfo().

AVBLOCKS_API primo::codecs::MediaBuffer* AVBLOCKS_CALL avb_create_media_buffer ( int32_t  capacity)

Creates a media buffer with the specified capacity.

The caller is responsible for releasing the object when it is not needed anymore.

Parameters:
capacityThe required capacity must be greater or equal to 0.
Returns:
A pointer to the new MediaBuffer object if capacity >= 0, otherwise NULL.
Remarks:
The returned object has a capacity that has been specified by the capacity parameter. It contains no data, i.e. dataSize() == 0.
See also:
Object Management
MediaBuffer

Referenced by primo::avblocks::Library::createMediaBuffer().

AVBLOCKS_API primo::avblocks::MediaBufferParameter* AVBLOCKS_CALL avb_create_media_buffer_parameter ( )

Creates a parameter that holds a MediaBuffer object.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Parameter object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createMediaBufferParameter().

AVBLOCKS_API primo::avblocks::MediaInfo* AVBLOCKS_CALL avb_create_media_info ( )

Creates a media information object.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MediaInfo object.
See also:
Object Management
MediaInfo

Referenced by primo::avblocks::Library::createMediaInfo().

AVBLOCKS_API primo::avblocks::MediaPin* AVBLOCKS_CALL avb_create_media_pin ( )

Creates a media pin.

It is used in input and output sockets of the transcoder. The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MediaPin object.
See also:
Object Management
MediaPin
MediaSocket
Transcoder

Referenced by primo::avblocks::Library::createMediaPin().

AVBLOCKS_API primo::codecs::MediaSample* AVBLOCKS_CALL avb_create_media_sample ( )

Creates an empty media sample.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MediaSample object.
See also:
Object Management
MediaSample

Referenced by primo::avblocks::Library::createMediaSample().

AVBLOCKS_API primo::avblocks::MediaSocket* AVBLOCKS_CALL avb_create_media_socket ( )

Creates a media socket.

It is used as an input or output point of the transcoder. The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MediaSocket object.
See also:
Object Management
MediaSocket
MediaPin
Transcoder

Referenced by primo::avblocks::Library::createMediaSocket().

AVBLOCKS_API primo::avblocks::MediaSocket* AVBLOCKS_CALL avb_create_media_socket_from_media_info ( primo::avblocks::MediaInfo *  )

Creates a media socket from a MediaInfo object.

Returns:
A pointer to the new MediaSocket object.
See also:
MediaSocket::createFromMediaInfo

Referenced by MediaSocket::createFromMediaInfo().

AVBLOCKS_API primo::avblocks::MediaSocket* AVBLOCKS_CALL avb_create_media_socket_from_preset ( primo::avblocks::Preset::Enum  ,
primo::avblocks::Quality::Enum   
)

Creates a media socket from an AVBlocks Preset.

Returns:
A pointer to the new MediaSocket object.
See also:
MediaSocket::createFromPreset

Referenced by MediaSocket::createFromPreset().

AVBLOCKS_API primo::codecs::MetaAttribute* AVBLOCKS_CALL avb_create_meta_attribute ( )

Creates an empty MetaAttribute object.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MetaAttribute object.
See also:
Object Management
Metadata
Metadata::attributes

Referenced by primo::avblocks::Library::createMetaAttribute().

AVBLOCKS_API primo::codecs::MetaPicture* AVBLOCKS_CALL avb_create_meta_picture ( )

Creates an empty MetaPicture object.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new MetaPicture object.
See also:
Object Management
Metadata
Metadata::pictures

Referenced by primo::avblocks::Library::createMetaPicture().

AVBLOCKS_API primo::codecs::Metadata* AVBLOCKS_CALL avb_create_metadata ( )

Creates an empty Metadata object.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Metadata object.
See also:
Object Management
Metadata
MediaSocket::setMetadata
MediaSocket::metadata

Referenced by primo::avblocks::Library::createMetadata().

AVBLOCKS_API primo::avblocks::ParameterList* AVBLOCKS_CALL avb_create_parameter_list ( )

Creates an empty collection of filter parameters.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new ParameterList object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createParameterList().

AVBLOCKS_API primo::avblocks::StringParameter* AVBLOCKS_CALL avb_create_string_parameter ( )

Creates a parameter that holds a char_t* string.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Parameter object.
See also:
Object Management
ParameterList

Referenced by primo::avblocks::Library::createStringParameter().

AVBLOCKS_API primo::avblocks::Transcoder* AVBLOCKS_CALL avb_create_transcoder ( )

Creates a Transcoder.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new Transcoder object.
See also:
Object Management
Transcoder

Referenced by primo::avblocks::Library::createTranscoder().

AVBLOCKS_API primo::codecs::VideoStreamInfo* AVBLOCKS_CALL avb_create_video_stream_info ( )

Creates an empty video stream info.

The caller is responsible for releasing the object when it is not needed anymore.

Returns:
A pointer to the new VideoStreamInfo object.
See also:
Object Management
VideoStreamInfo

Referenced by primo::avblocks::Library::createVideoStreamInfo().

AVBLOCKS_API bool_t AVBLOCKS_CALL avb_initialize ( )

Initializes the AVBlocks library.

Must be called once before the library is used, usually when the application starts.

Returns:
TRUE if the library is successfully initialized, otherwise FALSE.

Referenced by primo::avblocks::Library::initialize().

AVBLOCKS_API int32_t AVBLOCKS_CALL avb_set_license ( const char *  license)

Sets a license string.

The supplied license is appended to the library license state.

Parameters:
licenseA string with license information. If the license string is NULL the library license state is cleared.
Returns:
The status after the license is set. The returned value is a combination of flags from the LicenseStatusFlags enum.
Remarks:
A Demo build of the library cannot be licensed and always returns LicenseStatusFlags::DemoBuild.
See also:
primo::license::LicenseStatusFlags::Enum

Referenced by primo::avblocks::Library::setLicense().

AVBLOCKS_API void AVBLOCKS_CALL avb_shutdown ( )

Closes the AVBlocks library and frees the resources that are used (if any).

Should be called when the library will not be used anymore, e.g. when the application ends.

Referenced by primo::avblocks::Library::shutdown().

 All Classes Namespaces Files Functions Variables Enumerations Enumerator