Expand description
§Bindings to the VideoToolbox framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- VTCompression
Session VTCompressionSession - A reference to a Video Toolbox Compression Session.
- VTCompression
Session Option Flags VTCompressionSession - Apple’s documentation
- VTDecode
Frame Flags VTErrors - Directives for the decompression session and the video decoder, passed into decodeFlags parameter of VTDecompressionSessionDecodeFrame.
- VTDecode
Info Flags VTErrors - Informational status for decoding – non-error flags
- VTDecompression
Output Callback Record VTDecompressionSessionandVTErrorsandobjc2-core-mediaandobjc2-core-video - Apple’s documentation
- VTDecompression
Session VTDecompressionSession - A reference to a Video Toolbox Decompression Session.
- VTEncode
Info Flags VTErrors - Apple’s documentation
- VTFrame
Processor VTFrameProcessorandobjc2 - Creates a new VTFrameProcessor for the configured video effect
- VTFrame
Processor Error VTFrameProcessorErrorsandobjc2 - VTFrameProcessor error codes.
- VTFrame
Processor Frame VTFrameProcessorFrameandobjc2 - Helper class to wrap video frames that will be sent to the processor, as source frames, reference frames, or output frames. Instances retain the buffer backing them.
- VTFrame
Processor Optical Flow VTFrameProcessorFrameandobjc2 - Helper class to wrap optical flow that will be sent to the processor. Instances retain the buffers backing them.
- VTFrame
Rate Conversion Configuration VTFrameProcessor_FrameRateConversionandobjc2 - Configuration that is used to set up the FrameRateConversion Processor.
- VTFrame
Rate Conversion Configuration Quality Prioritization VTFrameProcessor_FrameRateConversionandobjc2 - Quality prioritization levels to favor quality or performance.
- VTFrame
Rate Conversion Configuration Revision VTFrameProcessor_FrameRateConversionandobjc2 - List of existing algorithm revisions with the highest being the latest. Clients can read defaultRevision property to find the default revision.
- VTFrame
Rate Conversion Parameters VTFrameProcessor_FrameRateConversionandobjc2 - VTFrameRateConversionParameters object contains both input and output parameters needed to run the FrameRateConversion processor on a frame. This object is used in the processWithParameters call of VTFrameProcessor class. The output parameter for this class is destinationFrame where the output frame is returned (as VTFrameProcessorMutableFrame) back to the caller function once the processWithParameters completes.
- VTFrame
Rate Conversion Parameters Submission Mode VTFrameProcessor_FrameRateConversionandobjc2 - Hint to let the processor know whether frames are being submitted in presenatation sequence, allowing performance optimizations based on previous processing requests
- VTFrame
Silo VTFrameSilo - A VTFrameSilo stores a large number of sample buffers, as produced by a multi-pass compression session.
- VTHDR
PerFrame Metadata Generation Session VTHDRPerFrameMetadataGenerationSession - A mechanism for generating HDR Per Frame Metadata and attaching that metadata to a CVPixelBuffer and the backing IOSurface.
- VTInt32
Point VTBase - Apple’s documentation
- VTInt32
Size VTBase - Apple’s documentation
- VTMotion
Blur Configuration VTFrameProcessor_MotionBlurandobjc2 - Configuration that is used to set up the MotionBlur Processor.
- VTMotion
Blur Configuration Quality Prioritization VTFrameProcessor_MotionBlurandobjc2 - Quality prioritization levels to favor quality or performance.
- VTMotion
Blur Configuration Revision VTFrameProcessor_MotionBlurandobjc2 - List of existing algorithm revisions with the highest being the latest. Clients can read defaultRevision property to find the default revision.
- VTMotion
Blur Parameters VTFrameProcessor_MotionBlurandobjc2 - VTMotionBlurParameters object contains both input and output parameters needed to run the MotionBlur processor on a frame. This object is used in the processWithParameters call of VTFrameProcessor class. The output parameter for this class is destinationFrame where the output frame is returned (as VTFrameProcessorFrame) back to the caller function once the processWithParameters completes.
- VTMotion
Blur Parameters Submission Mode VTFrameProcessor_MotionBlurandobjc2 - Hint to let the processor know whether frames are being submitted in presenatation sequence, allowing performance optimizations based on previous processing requests
- VTMulti
Pass Storage VTMultiPassStorage - A mechanism for storing information for each frame of a multi-pass compression session.
- VTOptical
Flow Configuration VTFrameProcessor_OpticalFlowandobjc2 - Configuration that is used to set up an OpticalFlow processor
- VTOptical
Flow Configuration Quality Prioritization VTFrameProcessor_OpticalFlowandobjc2 - Quality prioritization levels to favor quality or performance.
- VTOptical
Flow Configuration Revision VTFrameProcessor_OpticalFlowandobjc2 - List of existing algorithm revisions with the highest being the latest. Clients can read defaultRevision property to find the default revision.
- VTOptical
Flow Parameters VTFrameProcessor_OpticalFlowandobjc2 - VTOpticalFlowParameters object contains both input and output parameters needed to generate optical flow between two frames. This object is used in the processWithParameters call of VTFrameProcessor class. The output parameter for this class is destinationOpticalFlow where the output flow is returned (as VTFrameProcessorMutableOpticalFlow) back to the caller function once the processWithParameters completes.
- VTOptical
Flow Parameters Submission Mode VTFrameProcessor_OpticalFlowandobjc2 - Hint to let the processor know whether frames are being submitted in presenatation sequence, allowing performance optimizations based on previous processing requests
- VTPixel
Rotation Session VTPixelRotationSession - A reference to a Video Toolbox Pixel Rotation Session.
- VTPixel
Transfer Session VTPixelTransferSession - A reference to a Video Toolbox Pixel Transfer Session.
- VTRAW
Processing Session VTRAWProcessingSession - A reference to a Video Toolbox RAW Processing Session.
Constants§
- kVTAllocation
Failed Err VTErrors - Apple’s documentation
- kVTColor
Correction Image Rotation Failed Err VTErrors - Apple’s documentation
- kVTColor
Correction Pixel Transfer Failed Err VTErrors - Apple’s documentation
- kVTColor
Sync Transform Convert Failed Err VTErrors - Apple’s documentation
- kVTCould
NotCreate Color Correction Data Err VTErrors - Apple’s documentation
- kVTCould
NotCreate Instance Err VTErrors - Apple’s documentation
- kVTCould
NotFind Extension Err VTErrors - Apple’s documentation
- kVTCould
NotFind Temporal Filter Err VTErrors - Apple’s documentation
- kVTCould
NotFind Video Decoder Err VTErrors - Apple’s documentation
- kVTCould
NotFind Video Encoder Err VTErrors - Apple’s documentation
- kVTCould
NotOutput Tagged Buffer Group Err VTErrors - Apple’s documentation
- kVTExtension
Conflict Err VTErrors - Apple’s documentation
- kVTExtension
Disabled Err VTErrors - Apple’s documentation
- kVTFormat
Description Change NotSupported Err VTErrors - Apple’s documentation
- kVTFrame
Silo Invalid Time Range Err VTErrors - Apple’s documentation
- kVTFrame
Silo Invalid Time Stamp Err VTErrors - Apple’s documentation
- kVTImage
Rotation NotSupported Err VTErrors - Apple’s documentation
- kVTInsufficient
Source Color Data Err VTErrors - Apple’s documentation
- kVTInvalid
Session Err VTErrors - Apple’s documentation
- kVTMulti
Pass Storage Identifier Mismatch Err VTErrors - Apple’s documentation
- kVTMulti
Pass Storage Invalid Err VTErrors - Apple’s documentation
- kVTParameter
Err VTErrors - Apple’s documentation
- kVTPixel
Rotation NotSupported Err VTErrors - Apple’s documentation
- kVTPixel
Transfer NotPermitted Err VTErrors - Apple’s documentation
- kVTPixel
Transfer NotSupported Err VTErrors - Apple’s documentation
- kVTProperty
NotSupported Err VTErrors - Apple’s documentation
- kVTProperty
Read Only Err VTErrors - Apple’s documentation
- kVTQP
Modulation Level_ Default VTCompressionProperties - Apple’s documentation
- kVTQP
Modulation Level_ Disable VTCompressionProperties - Apple’s documentation
- kVTSession
Malfunction Err VTErrors - Apple’s documentation
- kVTUnlimited
Frame Delay Count VTCompressionProperties - Apple’s documentation
- kVTVideo
Decoder Authorization Err VTErrors - Apple’s documentation
- kVTVideo
Decoder BadData Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Callback Messaging Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Malfunction Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Needs Rosetta Err VTErrors - Apple’s documentation
- kVTVideo
Decoder NotAvailable NowErr VTErrors - Apple’s documentation
- kVTVideo
Decoder Reference Missing Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Removed Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Unknown Err VTErrors - Apple’s documentation
- kVTVideo
Decoder Unsupported Data Format Err VTErrors - Apple’s documentation
- kVTVideo
Encoder Authorization Err VTErrors - Apple’s documentation
- kVTVideo
EncoderMVHEVC Video LayerI DsMismatch Err VTErrors - Apple’s documentation
- kVTVideo
Encoder Malfunction Err VTErrors - Apple’s documentation
- kVTVideo
Encoder Needs Rosetta Err VTErrors - Apple’s documentation
- kVTVideo
Encoder NotAvailable NowErr VTErrors - Apple’s documentation
Statics§
- VTFrame
Processor ⚠Error Domain VTFrameProcessorErrorsandobjc2-foundation - Apple’s documentation
- kVTAlpha
Channel ⚠Mode_ Premultiplied Alpha VTCompressionProperties - Apple’s documentation
- kVTAlpha
Channel ⚠Mode_ Straight Alpha VTCompressionProperties - Apple’s documentation
- kVTCompression
Property ⚠Key_ Allow Frame Reordering VTCompressionProperties - Enables frame reordering.
- kVTCompression
Property ⚠Key_ Allow OpenGOP VTCompressionProperties - Enables Open GOP (Group Of Pictures) encoding.
- kVTCompression
Property ⚠Key_ Allow Temporal Compression VTCompressionProperties - Enables temporal compression.
- kVTCompression
Property ⚠Key_ Alpha Channel Mode VTCompressionProperties - Specifies whether the source images’ RGB values have been premultiplied by the alpha channel values.
- kVTCompression
Property ⚠Key_ Aspect Ratio16x9 VTCompressionProperties - Indicates that the DV video stream should have the 16x9 flag set.
- kVTCompression
Property ⚠Key_ Average BitRate VTCompressionProperties - The long-term desired average bit rate in bits per second.
- kVTCompression
Property ⚠Key_ Base Layer BitRate Fraction VTCompressionProperties - This property indicates the desired bit rate fraction of the base layer
- kVTCompression
Property ⚠Key_ Base Layer Frame Rate VTCompressionProperties - This property indicates the desired frame rate for the base temporal layer used in hierarchical video encoding.
- kVTCompression
Property ⚠Key_ Base Layer Frame Rate Fraction VTCompressionProperties - This property indicates the desired frame rate fraction of the base layer.
- kVTCompression
Property ⚠Key_ Calculate Mean Squared Error VTCompressionProperties - This property requests that the encoder measure and output the Mean Squared Error(MSE) quality metric.
- kVTCompression
Property ⚠Key_ Clean Aperture VTCompressionProperties - Describes the clean aperture for encoded frames.
- kVTCompression
Property ⚠Key_ Color Primaries VTCompressionProperties - Indicates color primaries for compressed content.
- kVTCompression
Property ⚠Key_ Constant BitRate VTCompressionProperties - Requires that the encoder use a Constant Bit Rate algorithm.
- kVTCompression
Property ⚠Key_ Content Light Level Info VTCompressionProperties - The value is 4 bytes containing a big-endian structure as defined in the Content Light Level Info SEI message.
- kVTCompression
Property ⚠Key_ Data Rate Limits VTCompressionProperties - Zero, one or two hard limits on data rate.
- kVTCompression
Property ⚠Key_ Depth VTCompressionProperties - The pixel depth of the encoded video.
- kVTCompression
Property ⚠Key_ EnableLTR VTCompressionProperties - Enable Long Term Reference (LTR) frames during encoding
- kVTCompression
Property ⚠Key_ EncoderID VTCompressionProperties - Specifies a particular video encoder by its ID string.
- kVTCompression
Property ⚠Key_ Estimated Average Bytes PerFrame VTCompressionProperties - Returns the encoder’s estimate of the expected size of a single encoded frame in bytes, based on current configuration.
- kVTCompression
Property ⚠Key_ Expected Duration VTCompressionProperties - Indicates the expected total duration for the compression session, if known.
- kVTCompression
Property ⚠Key_ Expected Frame Rate VTCompressionProperties - Indicates the expected frame rate of the video to be encoded.
- kVTCompression
Property ⚠Key_ Field Count VTCompressionProperties - Indicates whether the frames should be encoded progressive (1) or interlaced (2).
- kVTCompression
Property ⚠Key_ Field Detail VTCompressionProperties - Indicates field ordering for encoded interlaced frames.
- kVTCompression
Property ⚠Key_ Gamma Level VTCompressionProperties - Indicates gamma level for compressed content.
- kVTCompression
Property ⚠Key_ H264 Entropy Mode VTCompressionProperties - The entropy encoding mode for H.264 compression.
- kVTCompression
Property ⚠Key_ HDRMetadata Insertion Mode VTCompressionProperties - The mode for HDR metadata in the output bitstream.
- kVTCompression
Property ⚠Key_ HasLeft Stereo EyeView VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_HasLeftStereoEyeView.
- kVTCompression
Property ⚠Key_ HasRight Stereo EyeView VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_HasRightStereoEyeView.
- kVTCompression
Property ⚠Key_ Hero Eye VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_HeroEye.
- kVTCompression
Property ⚠Key_ Horizontal Disparity Adjustment VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_HorizontalDisparityAdjustment.
- kVTCompression
Property ⚠Key_ Horizontal Field OfView VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_HorizontalFieldOfView.
- kVTCompression
Property ⚠Key_ ICCProfile VTCompressionProperties - Indicates ICC profile for compressed content.
- kVTCompression
Property ⚠Key_ MVHEVC Left AndRight ViewI Ds VTCompressionProperties - Specifies which of the ViewIDs provided via kVTCompressionPropertyKey_MVHEVCViewIDs is the “left view id” and which is the “right view id”.
- kVTCompression
Property ⚠Key_ MVHEVC Video LayerI Ds VTCompressionProperties - Requests multi-image encoding; advises encoder to expect CMTaggedBufferGroups with specific CMTags referencing these MV-HEVC VideoLayerIDs.
- kVTCompression
Property ⚠Key_ MVHEVC ViewI Ds VTCompressionProperties - Specifies the ViewIDs corresponding to the VideoLayerIDs provided via kVTCompressionPropertyKey_MVHEVCVideoLayerIDs.
- kVTCompression
Property ⚠Key_ Mastering Display Color Volume VTCompressionProperties - The value is 24 bytes containing a big-endian structure as defined in ISO/IEC 23008-2:2015(E), D.2.28 Mastering display colour volume SEI message.
- kVTCompression
Property ⚠Key_ MaxAllowed FrameQP VTCompressionProperties - Specifies the maximum allowed encoded frame QP (Quantization Parameter).
- kVTCompression
Property ⚠Key_ MaxFrame Delay Count VTCompressionProperties - The maximum frame delay count is the maximum number of frames that a compressor is allowed to hold before it must output a compressed frame.
- kVTCompression
Property ⚠Key_ MaxH264 Slice Bytes VTCompressionProperties - Specifies the maximum slice size for H.264 encoding
- kVTCompression
Property ⚠Key_ MaxKey Frame Interval VTCompressionProperties - The maximum interval between key frames, also known as the key frame rate.
- kVTCompression
Property ⚠Key_ MaxKey Frame Interval Duration VTCompressionProperties - The maximum duration from one key frame to the next in seconds.
- kVTCompression
Property ⚠Key_ Maximize Power Efficiency VTCompressionProperties - Hints to the video encoder that it should maximize power efficiency during encode.
- kVTCompression
Property ⚠Key_ Maximum Real Time Frame Rate VTCompressionProperties - Indicates the maximum real time rate at which frames could be submitted to the VTCompressionSession
- kVTCompression
Property ⚠Key_ MinAllowed FrameQP VTCompressionProperties - Specifies the minimum allowed encoded frame QP (Quantization Parameter).
- kVTCompression
Property ⚠Key_ More Frames After End VTCompressionProperties - Indicates whether and how a compression session’s frames will be concatenated with other compressed frames to form a longer series.
- kVTCompression
Property ⚠Key_ More Frames Before Start VTCompressionProperties - Indicates whether and how a compression session’s frames will be concatenated with other compressed frames to form a longer series.
- kVTCompression
Property ⚠Key_ Multi Pass Storage VTCompressionProperties - Enables multi-pass compression and provides storage for encoder-private data.
- kVTCompression
Property ⚠Key_ Number OfPending Frames VTCompressionProperties - The number of pending frames in the compression session.
- kVTCompression
Property ⚠Key_ Output BitDepth VTCompressionProperties - When set, requires the encoder to output bitstream with the requested bit depth, if supported by the configured profile level setting. In the absence of this property, the video encoder will assume the highest bit depth allowable by the configured profile level setting.
- kVTCompression
Property ⚠Key_ Pixel Aspect Ratio VTCompressionProperties - Describes the pixel aspect ratio for encoded frames.
- kVTCompression
Property ⚠Key_ Pixel Buffer Pool IsShared VTCompressionProperties - Indicates whether the a common pixel buffer pool is shared between the video encoder and the session client.
- kVTCompression
Property ⚠Key_ Pixel Transfer Properties VTCompressionProperties - Specifies properties to configure a VTPixelTransferSession used to transfer source frames from the client’s image buffers to the video encoder’s image buffers, if necessary.
- kVTCompression
Property ⚠Key_ Preserve Alpha Channel VTCompressionProperties - Instructs the encoder to encode or discard the alpha channel of input video frames
- kVTCompression
Property ⚠Key_ Preserve DynamicHDR Metadata VTCompressionProperties - Controls whether or not to preserve any dynamic HDR metadata on the input pixel buffer
- kVTCompression
Property ⚠Key_ Prioritize Encoding Speed Over Quality VTCompressionProperties - Hint for the video encoder that it should maximize its speed during encode, sacrificing quality if needed
- kVTCompression
Property ⚠Key_ Profile Level VTCompressionProperties - Specifies the profile and level for the encoded bitstream.
- kVTCompression
Property ⚠Key_ Progressive Scan VTCompressionProperties - Indicates that the DV video stream should have the progressive flag set.
- kVTCompression
Property ⚠Key_ Projection Kind VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_ProjectionKind.
- kVTCompression
Property ⚠Key_ Quality VTCompressionProperties - The desired compression quality.
- kVTCompression
Property ⚠Key_ Real Time VTCompressionProperties - Hints the video encoder that compression is, or is not, being performed in real time.
- kVTCompression
Property ⚠Key_ Recommended Parallelization Limit VTCompressionProperties - If supported by the underlying video encoder, returns the recommended number of VTCompressionSessions to instantiate in a parallel encoding configuration.
- kVTCompression
Property ⚠Key_ Recommended Parallelized Subdivision Minimum Duration VTCompressionProperties - If supported by the underlying video encoder, returns the recommended minimum duration for a given subdivision in a parallel encoding configuration.
- kVTCompression
Property ⚠Key_ Recommended Parallelized Subdivision Minimum Frame Count VTCompressionProperties - If supported by the underlying video encoder, returns the recommended minimum number of video frames for a given subdivision in a parallel encoding configuration.
- kVTCompression
Property ⚠Key_ Reference Buffer Count VTCompressionProperties - The client will be able to control the the maximum allowed ReferenceBufferCount using this optional key.
- kVTCompression
Property ⚠Key_ Source Frame Count VTCompressionProperties - Indicates the number of source frames, if known.
- kVTCompression
Property ⚠Key_ Spatial AdaptiveQP Level VTCompressionProperties - Control spatial adaptation of the quantization parameter (QP) based on per-frame statistics. If set to kVTAdaptiveQPLevel_Disable, spatial QP adaptation is not applied based on per-frame statistics. If set to kVTAdaptiveQPLevel_Default, video encoder is allowed to apply spatial QP adaptation for each macro block (or coding unit) within a video frame. QP adaptation is based on spatial characteristics of a frame and the level of spatial QP adaptation is decided internally by the rate controller.
- kVTCompression
Property ⚠Key_ Stereo Camera Baseline VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_StereoCameraBaseline.
- kVTCompression
Property ⚠Key_ Suggested Look Ahead Frame Count VTCompressionProperties - Requests that the encoder retain the specified number of frames during encoding. These frames will be used for additional analysis and statistics gathering before the frame is finally encoded at the end of the window. When this property is not set, video encoder will automatically determine the number of lookahead frames.
- kVTCompression
Property ⚠Key_ Supports Base FrameQP VTCompressionProperties - This property can be queried to determine if the encoder supports base frame QP requests.
- kVTCompression
Property ⚠Key_ Target Quality ForAlpha VTCompressionProperties - The target quality to use for encoding the alpha channel.
- kVTCompression
Property ⚠Key_ Transfer Function VTCompressionProperties - Indicates transfer function for compressed content.
- kVTCompression
Property ⚠Key_ UsingGPU RegistryID VTCompressionProperties - returns CFNumber indicating the gpu registryID of the encoder that was selected. NULL indicates a built-in encoder or software encode was used.
- kVTCompression
Property ⚠Key_ Using Hardware Accelerated Video Encoder VTCompressionProperties - If set to kCFBooleanTrue, a hardware accelerated video encoder is being used.
- kVTCompression
Property ⚠Key_ Video Encoder Pixel Buffer Attributes VTCompressionProperties - The video encoder’s pixel buffer attributes for the compression session.
- kVTCompression
Property ⚠Key_ View Packing Kind VTCompressionProperties - Specifies the value of kCMFormatDescriptionExtension_ViewPackingKind.
- kVTCompression
Property ⚠Key_ YCbCr Matrix VTCompressionProperties - Indicates YCbCr matrix for compressed content.
- kVTDecompression
Property ⚠Key_ Allow Bitstream ToChange Frame Dimensions VTDecompressionProperties - True if decoder is allowed to output buffers matching reduced frame dimensions in the bitstream rather than under-filling them.
- kVTDecompression
Property ⚠Key_ Content HasInterframe Dependencies VTDecompressionProperties - Indicates whether the content being decoded has interframe dependencies, if the decoder knows.
- kVTDecompression
Property ⚠Key_ Decoder ProducesRAW Output VTDecompressionProperties - Indicates whether the decoder can produce RAW output requiring a VTRAWProcessingSession for post-decode processing.
- kVTDecompression
Property ⚠Key_ Deinterlace Mode VTDecompressionProperties - Requests a specific deinterlacing technique.
- kVTDecompression
Property ⚠Key_ Field Mode VTDecompressionProperties - Requests special handling of interlaced content.
- kVTDecompression
Property ⚠Key_ Generate PerFrameHDR Display Metadata VTDecompressionProperties - Generates Per Frame HDR Metadata and attaches it to the resulting decoded CVPixelBuffers.
- kVTDecompression
Property ⚠Key_ MaxOutput Presentation Time Stamp OfFrames Being Decoded VTDecompressionProperties - The maximum output presentation timestamp of the frames currently being decoded.
- kVTDecompression
Property ⚠Key_ Maximize Power Efficiency VTDecompressionProperties - Hints to the video decoder that it should maximize power efficiency during decoding.
- kVTDecompression
Property ⚠Key_ MinOutput Presentation Time Stamp OfFrames Being Decoded VTDecompressionProperties - The minimum output presentation timestamp of the frames currently being decoded.
- kVTDecompression
Property ⚠Key_ Number OfFrames Being Decoded VTDecompressionProperties - Returns the number of frames currently being decoded.
- kVTDecompression
Property ⚠Key_ Only These Frames VTDecompressionProperties - Requests that frames be filtered by type.
- kVTDecompression
Property ⚠Key_ Output Pool Requested Minimum Buffer Count VTDecompressionProperties - Requests that the VTDecompressionSession use the value provided as a minimum buffer count for its output CVPixelBufferPool, not releasing buffers while the number in use is below this level.
- kVTDecompression
Property ⚠Key_ Pixel Buffer Pool VTDecompressionProperties - A pixel buffer pool for pixel buffers being output by the decompression session.
- kVTDecompression
Property ⚠Key_ Pixel Buffer Pool IsShared VTDecompressionProperties - Indicates whether a common pixel buffer pool is shared between the video decoder and the session client.
- kVTDecompression
Property ⚠Key_ Pixel Formats With Reduced Resolution Support VTDecompressionProperties - Indicates which pixel formats support reduced resolution decoding.
- kVTDecompression
Property ⚠Key_ Pixel Transfer Properties VTDecompressionProperties - Requests particular pixel transfer features.
- kVTDecompression
Property ⚠Key_ Propagate PerFrameHDR Display Metadata VTDecompressionProperties - This controls whether or not to propagate any per frame HDR display metadata from the input compressed bitstream to the output pixel buffer.
- kVTDecompression
Property ⚠Key_ Real Time VTDecompressionProperties - Hints the video decoder that decompression is, or is not, being performed in real time.
- kVTDecompression
Property ⚠Key_ Reduced Coefficient Decode VTDecompressionProperties - Requests approximation during decoding.
- kVTDecompression
Property ⚠Key_ Reduced Frame Delivery VTDecompressionProperties - Requests frame dropping.
- kVTDecompression
Property ⚠Key_ Reduced Resolution Decode VTDecompressionProperties - Requests decoding at a smaller resolution than full-size.
- kVTDecompression
Property ⚠Key_ RequestRAW Output VTDecompressionProperties - For decoders which produce RAW output, this property requests that the VTDecompressionSession provide output which has not been processed.
- kVTDecompression
Property ⚠Key_ RequestedMVHEVC Video LayerI Ds VTDecompressionProperties - Requests multi-image decoding of specific MV-HEVC VideoLayerIDs.
- kVTDecompression
Property ⚠Key_ Suggested Quality OfService Tiers VTDecompressionProperties - Suggests how quality-of-service may be lowered in order to maintain realtime playback.
- kVTDecompression
Property ⚠Key_ Supported Pixel Formats Ordered ByPerformance VTDecompressionProperties - Provides hints about speed tradeoffs between pixel formats.
- kVTDecompression
Property ⚠Key_ Supported Pixel Formats Ordered ByQuality VTDecompressionProperties - Provides hints about quality tradeoffs between pixel formats.
- kVTDecompression
Property ⚠Key_ Thread Count VTDecompressionProperties - Gets number of threads used by codec or suggests number of threads to use.
- kVTDecompression
Property ⚠Key_ UsingGPU RegistryID VTDecompressionProperties - returns CFNumber indicating the gpu registryID of the decoder that was selected. NULL indicates a built-in decoder or software decode was used.
- kVTDecompression
Property ⚠Key_ Using Hardware Accelerated Video Decoder VTDecompressionProperties - If set to kCFBooleanTrue, a hardware accelerated video decoder is being used.
- kVTDecompression
Property_ ⚠Deinterlace Mode_ Temporal VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Deinterlace Mode_ Vertical Filter VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Field Mode_ Both Fields VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Field Mode_ Bottom Field Only VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Field Mode_ Deinterlace Fields VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Field Mode_ Single Field VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Field Mode_ TopField Only VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Only These Frames_ AllFrames VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Only These Frames_ IFrames VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Only These Frames_ KeyFrames VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Only These Frames_ NonDroppable Frames VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Property_ ⚠Temporal Level Limit VTDecompressionProperties - Requests that frames be filtered by temporal level.
- kVTDecompression
Resolution ⚠Key_ Height VTDecompressionProperties - Apple’s documentation
- kVTDecompression
Resolution ⚠Key_ Width VTDecompressionProperties - Apple’s documentation
- kVTDownsampling
Mode_ ⚠Average VTPixelTransferProperties - Apple’s documentation
- kVTDownsampling
Mode_ ⚠Decimate VTPixelTransferProperties - Apple’s documentation
- kVTEncode
Frame ⚠Option Key_ AcknowledgedLTR Tokens VTCompressionProperties - A CFArray of CFNumbers containing the kVTSampleAttachmentKey_RequireLTRAcknowledgementToken values which have been successfully sent to the receiver and can be used as references
- kVTEncode
Frame ⚠Option Key_ Base FrameQP VTCompressionProperties - CFNumberRef requesting the current frame to use the provided base frame QP.
- kVTEncode
Frame ⚠Option Key_ Force KeyFrame VTCompressionProperties - CFBoolean forcing the current frame to be a key frame
- kVTEncode
Frame ⚠Option Key_ ForceLTR Refresh VTCompressionProperties - Set this option to kCFBooleanTrue to force an LTR refresh
- kVTExtension
Properties_ ⚠Codec Name Key VTUtilities - A CFDictionary key for the user readable name string of the codec.
- kVTExtension
Properties_ ⚠Containing Bundle Name Key VTUtilities - A CFDictionary key for the extension host application localized name.
- kVTExtension
Properties_ ⚠Containing BundleURL Key VTUtilities - A CFDictionary key for the URL of the extension host application.
- kVTExtension
Properties_ ⚠Extension Identifier Key VTUtilities - A CFDictionary key for the video decoder extension identifier.
- kVTExtension
Properties_ ⚠Extension Name Key VTUtilities - A CFDictionary key for the localized extension name.
- kVTExtension
Properties_ ⚠ExtensionURL Key VTUtilities - A CFDictionary key for the URL of the extension.
- kVTH264
Entropy ⚠Mode_ CABAC VTCompressionProperties - Apple’s documentation
- kVTH264
Entropy ⚠Mode_ CAVLC VTCompressionProperties - Apple’s documentation
- kVTHDR
Metadata ⚠Insertion Mode_ Auto VTCompressionProperties - Apple’s documentation
- kVTHDR
Metadata ⚠Insertion Mode_ None VTCompressionProperties - Apple’s documentation
- kVTHDR
PerFrame ⚠Metadata GenerationHDR Format Type_ Dolby Vision VTHDRPerFrameMetadataGenerationSession - Specifies that DolbyVision data should be generated and attached for each pixel buffer.
- kVTHDR
PerFrame ⚠Metadata Generation Options Key_ HDRFormats VTHDRPerFrameMetadataGenerationSession - Specifies an array of HDR formats that should be generated.
- kVTMulti
Pass ⚠Storage Creation Option_ DoNot Delete VTMultiPassStorage - Apple’s documentation
- kVTPixel
Rotation ⚠Property Key_ Flip Horizontal Orientation VTPixelRotationProperties - Specifies the horizontal flip.
- kVTPixel
Rotation ⚠Property Key_ Flip Vertical Orientation VTPixelRotationProperties - Specifies the vertical flip.
- kVTPixel
Rotation ⚠Property Key_ Rotation VTPixelRotationProperties - Specifies the amount of rotation in degrees.
- kVTPixel
Transfer ⚠Property Key_ Destination Clean Aperture VTPixelTransferProperties - Specifies the clean aperture for destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ Destination Color Primaries VTPixelTransferProperties - Specifies the color primaries to be used for destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ DestinationICC Profile VTPixelTransferProperties - Specifies the ICC profile for destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ Destination Pixel Aspect Ratio VTPixelTransferProperties - Specifies the pixel aspect ratio for destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ Destination Transfer Function VTPixelTransferProperties - Specifies the color transfer function to be used for destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ DestinationY CbCr Matrix VTPixelTransferProperties - Specifies the color matrix to be used for YCbCr->RGB conversions involving the destination image buffers.
- kVTPixel
Transfer ⚠Property Key_ Downsampling Mode VTPixelTransferProperties - Requests a specific chroma downsampling technique be used.
- kVTPixel
Transfer ⚠Property Key_ Real Time VTPixelTransferProperties - Hints the transfer session that the operation is, or is not, being performed in real time.
- kVTPixel
Transfer ⚠Property Key_ Scaling Mode VTPixelTransferProperties - Indicates how images should be scaled.
- kVTProfile
Level_ ⚠H263_ Profile0_ Level10 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H263_ Profile0_ Level45 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H263_ Profile3_ Level45 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 1_ 3 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 3_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 3_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 3_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 4_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 4_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 4_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 5_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 5_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ 5_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Baseline_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Constrained Baseline_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Constrained High_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Extended_ 5_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Extended_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 3_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 3_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 3_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 4_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 4_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 4_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 5_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 5_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ 5_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ High_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 3_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 3_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 3_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 4_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 4_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 4_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 5_ 0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 5_ 1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ 5_ 2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠H264_ Main_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠HEVC_ Main10_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠HEVC_ Main42210_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠HEVC_ Main_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠HEVC_ Monochrome10_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠HEVC_ Monochrome_ Auto Level VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Advanced Simple_ L0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Advanced Simple_ L1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Advanced Simple_ L2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Advanced Simple_ L3 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Advanced Simple_ L4 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Main_ L2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Main_ L3 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Main_ L4 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Simple_ L0 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Simple_ L1 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Simple_ L2 VTCompressionProperties - Apple’s documentation
- kVTProfile
Level_ ⚠MP4V_ Simple_ L3 VTCompressionProperties - Apple’s documentation
- kVTProperty
Documentation ⚠Key VTSession - Apple’s documentation
- kVTProperty
Read ⚠Write Status Key VTSession - Apple’s documentation
- kVTProperty
Read ⚠Write Status_ Read Only VTSession - Apple’s documentation
- kVTProperty
Read ⚠Write Status_ Read Write VTSession - Apple’s documentation
- kVTProperty
Should ⚠BeSerialized Key VTSession - Apple’s documentation
- kVTProperty
Supported ⚠Value List Key VTSession - Apple’s documentation
- kVTProperty
Supported ⚠Value Maximum Key VTSession - Apple’s documentation
- kVTProperty
Supported ⚠Value Minimum Key VTSession - Apple’s documentation
- kVTProperty
Type ⚠Key VTSession - Apple’s documentation
- kVTProperty
Type_ ⚠Boolean VTSession - Apple’s documentation
- kVTProperty
Type_ ⚠Enumeration VTSession - Apple’s documentation
- kVTProperty
Type_ ⚠Number VTSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter List Element_ Description VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter List Element_ Label VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter List Element_ List ElementID VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter Value Type_ Boolean VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter Value Type_ Float VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter Value Type_ Integer VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter Value Type_ List VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter Value Type_ SubGroup VTRAWProcessingSession - Apple’s documentation
- kVTRAW
Processing ⚠Parameter_ Camera Value VTRAWProcessingSession - The value corresponding to this key is the “As Shot” value for this parameter as originally captured by the camera. For List types, this is the ListElementID for the List element.
- kVTRAW
Processing ⚠Parameter_ Current Value VTRAWProcessingSession - The value corresponding to this key is the currently configured value for this parameter. For List types, this is the ListElementID for the List element.
- kVTRAW
Processing ⚠Parameter_ Description VTRAWProcessingSession - The value corresponding to this key is a localized string with a description of the parameter suitable for display in a tooltip or other descriptive UI.
- kVTRAW
Processing ⚠Parameter_ Enabled VTRAWProcessingSession - The value corresponding to this key is Boolean indicating whether the parameter is enabled and can be modified.
- kVTRAW
Processing ⚠Parameter_ Initial Value VTRAWProcessingSession - The value corresponding to this key is the initial value for this parameter as defined by the container and metadata provided at creation time. For List types, this is the ListElementID for the List element.
- kVTRAW
Processing ⚠Parameter_ Key VTRAWProcessingSession - The value corresponding to this key is the string used when specifying this parameter when calling VTRAWProcessingSessionSetProcessingParameters.
- kVTRAW
Processing ⚠Parameter_ List Array VTRAWProcessingSession - The value corresponding to this key is a CFArray of CFDictionaries describing each element in the list..
- kVTRAW
Processing ⚠Parameter_ Maximum Value VTRAWProcessingSession - The value corresponding to this key is the maximum value allowed for this parameter when calling VTRAWProcessingSessionSetProcessingParameters. This parameter is optional and not required for parameters where it is not appropriate (such as Boolean or List types).
- kVTRAW
Processing ⚠Parameter_ Minimum Value VTRAWProcessingSession - The value corresponding to this key is the minimum value allowed for this parameter when calling VTRAWProcessingSessionSetProcessingParameters. This parameter is optional and not required for parameters where it is not appropriate (such as Boolean or List types).
- kVTRAW
Processing ⚠Parameter_ Name VTRAWProcessingSession - The value corresponding to this key is a localized string which can be displayed in UI representing this parameter.
- kVTRAW
Processing ⚠Parameter_ Neutral Value VTRAWProcessingSession - The value corresponding to this key is a neutral setting for the processor. For List types, this is the ListElementID for the List element.
- kVTRAW
Processing ⚠Parameter_ SubGroup VTRAWProcessingSession - The value corresponding to this key is a CFArray of CFDictionaries representing the individual sub-parameters in this group.
- kVTRAW
Processing ⚠Parameter_ Value Type VTRAWProcessingSession - The value corresponding to this key is the type of the parameter - a Boolean, Integer, Float, List, or SubGroup.
- kVTRAW
Processing ⚠Property Key_ Metal Device RegistryID VTRAWProcessingProperties - This property, if supported, requests that the Metal device corresponding to the specified registryID be used for any Metal related processing
- kVTRAW
Processing ⚠Property Key_ Output Color Attachments VTRAWProcessingProperties - Returns the color-related CVImageBuffer keys and values that will be attachments to the returned pixel buffers.
- kVTRotation_
0 ⚠VTPixelRotationProperties - Apple’s documentation
- kVTRotation_
180 ⚠VTPixelRotationProperties - Apple’s documentation
- kVTRotation_
CCW90 ⚠VTPixelRotationProperties - Apple’s documentation
- kVTRotation_
CW90 ⚠VTPixelRotationProperties - Apple’s documentation
- kVTSample
Attachment ⚠Key_ Quality Metrics VTCompressionProperties - The value for this key contain quality-related metadata from the video encoder for a video frame.
- kVTSample
Attachment ⚠Key_ RequireLTR Acknowledgement Token VTCompressionProperties - CFNumber containing a unique token for this LTR
- kVTSample
Attachment ⚠Quality Metrics Key_ Chroma Blue Mean Squared Error VTCompressionProperties - Key for mean squared error (MSE) of the encoded Chroma Blue channel from the video encoder.
- kVTSample
Attachment ⚠Quality Metrics Key_ Chroma RedMean Squared Error VTCompressionProperties - Key for mean squared error (MSE) of the encoded Chroma Red channel from the video encoder.
- kVTSample
Attachment ⚠Quality Metrics Key_ Luma Mean Squared Error VTCompressionProperties - Key for mean squared error (MSE) of the encoded Luma channel from the video encoder.
- kVTScaling
Mode_ ⚠Crop Source ToClean Aperture VTPixelTransferProperties - Apple’s documentation
- kVTScaling
Mode_ ⚠Letterbox VTPixelTransferProperties - Apple’s documentation
- kVTScaling
Mode_ ⚠Normal VTPixelTransferProperties - Apple’s documentation
- kVTScaling
Mode_ ⚠Trim VTPixelTransferProperties - Apple’s documentation
- kVTVideo
Decoder ⚠Specification_ Enable Hardware Accelerated Video Decoder VTDecompressionProperties - If set to kCFBooleanTrue, the VideoToolbox will use a hardware accelerated video decoder if available. If set to kCFBooleanFalse, hardware decode will never be used.
- kVTVideo
Decoder ⚠Specification_ Preferred DecoderGPU RegistryID VTDecompressionProperties - If set, the VideoToolbox will try to use a hardware decoder running on the GPU specified by the provided GPU registryID. If the GPU does not support decode of the specified format, the VideoToolbox will fall back to alternate decoders.
- kVTVideo
Decoder ⚠Specification_ Require Hardware Accelerated Video Decoder VTDecompressionProperties - If set to kCFBooleanTrue, the VideoToolbox will try to allocate a hardware accelerated decoder and return an error if that isn’t possible. Setting this key automatically implies kVTVideoDecoderSpecification_EnableHardwareAcceleratedVideoDecoder – there is no need to set both and the Enable key does nothing if the Require key is set.
- kVTVideo
Decoder ⚠Specification_ Required DecoderGPU RegistryID VTDecompressionProperties - If set, the VideoToolbox will only use a hardware decoder running on the GPU specified by the provided GPU registryID.
- kVTVideo
Encoder ⚠List Option_ Include Standard DefinitionDV Encoders VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Codec Name VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Codec Type VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Display Name VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ EncoderID VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Encoder Name VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ GPURegistryID VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Instance Limit VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ IsHardware Accelerated VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Performance Rating VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Quality Rating VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Supported Selection Properties VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Supports Frame Reordering VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠List_ Supports Multi Pass VTVideoEncoderList - Apple’s documentation
- kVTVideo
Encoder ⚠Specification_ Enable Hardware Accelerated Video Encoder VTCompressionProperties - If set to kCFBooleanTrue, use a hardware accelerated video encoder if available. If set to kCFBooleanFalse, hardware encode will never be used.
- kVTVideo
Encoder ⚠Specification_ Enable LowLatency Rate Control VTCompressionProperties - Requires that an encoder which supports low-latency operation be selected, and enables low-latency mode.
- kVTVideo
Encoder ⚠Specification_ EncoderID VTCompressionSession - Specifies a particular video encoder by its ID string.
- kVTVideo
Encoder ⚠Specification_ Preferred EncoderGPU RegistryID VTCompressionProperties - If set, the VideoToolbox will try to use a hardware encoder running on the GPU specified by the provided GPU registryID. If the GPU does not support encode of the specified format, the VideoToolbox will fall back to alternate encoders.
- kVTVideo
Encoder ⚠Specification_ Require Hardware Accelerated Video Encoder VTCompressionProperties - If set to kCFBooleanTrue, only use hardware encode and return an error if this isn’t possible. Setting this key automatically implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder – there is no need to set both and the Enable key does nothing if the Require key is set.
- kVTVideo
Encoder ⚠Specification_ Required EncoderGPU RegistryID VTCompressionProperties - If set, the VideoToolbox will only use a hardware encoder running on the GPU specified by the provided GPU registryID.
Traits§
- VTFrame
Processor Configuration VTFrameProcessorConfigurationandobjc2 - The VTFrameProcessorConfiguration protocol describes the configuration of a processor to be used during a video processing session.
- VTFrame
Processor Parameters VTFrameProcessorParametersandobjc2 - VTFrameProcessorParameters is the base protocol for input and output processing parameters for a VTFrameProcessor processing implementation.. An instance of a class corresponding to this protocol is passed to processFrameWithParameters calls, and in async versions of those APIs, the same instance is returned in the completion.
Functions§
- VTCompression
Session ⚠Begin Pass Deprecated VTCompressionSession - VTCompression
Session ⚠Complete Frames Deprecated VTCompressionSessionandobjc2-core-media - VTCompression
Session ⚠Create Deprecated VTErrorsandobjc2-core-mediaandVTCompressionSession - VTCompression
Session ⚠Encode Frame Deprecated VTErrorsandobjc2-core-mediaandobjc2-core-videoandVTCompressionSession - VTCompression
Session ⚠Encode Frame With Output Handler Deprecated VTErrorsandblock2andobjc2-core-mediaandobjc2-core-videoandVTCompressionSession - VTCompression
Session ⚠Encode Multi Image Frame Deprecated VTErrorsandobjc2-core-mediaandVTCompressionSession - VTCompression
Session ⚠Encode Multi Image Frame With Output Handler Deprecated VTErrorsandblock2andobjc2-core-mediaandVTCompressionSession - VTCompression
Session ⚠EndPass Deprecated VTCompressionSession - VTCompression
Session ⚠GetPixel Buffer Pool Deprecated VTCompressionSessionandobjc2-core-video - VTCompression
Session ⚠GetTime Ranges ForNext Pass Deprecated VTCompressionSessionandobjc2-core-media - VTCompression
Session ⚠Invalidate Deprecated VTCompressionSession - VTCompression
Session ⚠Prepare ToEncode Frames Deprecated VTCompressionSession - VTCopyRAW
Processor ⚠Extension Properties VTUtilitiesandobjc2-core-media - Returns information about the Media Extension RAW processor supporting the specified format.
- VTCopy
Supported ⚠Property Dictionary ForEncoder VTVideoEncoderListandobjc2-core-media - Builds a list of supported properties and encoder ID for an encoder
- VTCopy
Video ⚠Decoder Extension Properties VTUtilitiesandobjc2-core-media - Returns information about the Media Extension video decoder required to decode the specified format.
- VTCopy
Video ⚠Encoder List VTVideoEncoderList - Builds a list of available video encoders.
- VTCreateCG
Image ⚠FromCV Pixel Buffer objc2-core-graphicsandobjc2-core-videoandVTUtilities - Creates a CGImage using the provided CVPixelBuffer
- VTDecompression
Session ⚠CanAccept Format Description Deprecated VTDecompressionSessionandobjc2-core-media - VTDecompression
Session ⚠Copy Black Pixel Buffer Deprecated VTDecompressionSessionandobjc2-core-video - VTDecompression
Session ⚠Create Deprecated VTErrorsandobjc2-core-mediaandobjc2-core-videoandVTDecompressionSession - VTDecompression
Session ⚠Decode Frame Deprecated VTErrorsandobjc2-core-mediaandVTDecompressionSession - VTDecompression
Session ⚠Decode Frame With Multi Image Capable Output Handler Deprecated VTErrorsandblock2andobjc2-core-mediaandobjc2-core-videoandVTDecompressionSession - VTDecompression
Session ⚠Decode Frame With Output Handler Deprecated VTErrorsandblock2andobjc2-core-mediaandobjc2-core-videoandVTDecompressionSession - VTDecompression
Session ⚠Finish Delayed Frames Deprecated VTDecompressionSession - VTDecompression
Session ⚠Invalidate Deprecated VTDecompressionSession - VTDecompression
Session ⚠SetMulti Image Callback Deprecated VTErrorsandobjc2-core-mediaandVTDecompressionSession - VTDecompression
Session ⚠Wait ForAsynchronous Frames Deprecated VTDecompressionSession - VTFrame
Silo ⚠AddSample Buffer Deprecated VTFrameSiloandobjc2-core-media - VTFrame
Silo ⚠Call Block ForEach Sample Buffer Deprecated block2andobjc2-core-mediaandVTFrameSilo - VTFrame
Silo ⚠Call Function ForEach Sample Buffer Deprecated VTFrameSiloandobjc2-core-media - VTFrame
Silo ⚠Create Deprecated VTFrameSiloandobjc2-core-media - VTFrame
Silo ⚠GetProgress OfCurrent Pass Deprecated VTFrameSilo - VTFrame
Silo ⚠SetTime Ranges ForNext Pass Deprecated VTFrameSiloandobjc2-core-media - VTHDR
PerFrame ⚠Metadata Generation Session Attach Metadata Deprecated VTHDRPerFrameMetadataGenerationSessionandobjc2-core-video - VTHDR
PerFrame ⚠Metadata Generation Session Create Deprecated VTHDRPerFrameMetadataGenerationSession - VTIs
Hardware ⚠Decode Supported VTDecompressionSessionandobjc2-core-media - Indicates whether the current system supports hardware decode for a given codec
- VTIs
StereoMVHEVC ⚠Decode Supported VTDecompressionSession - Indicates whether the current system supports stereo MV-HEVC decode.
- VTIs
StereoMVHEVC ⚠Encode Supported VTCompressionSession - Indicates whether the current system supports stereo MV-HEVC encode.
- VTMulti
Pass ⚠Storage Close Deprecated VTMultiPassStorage - VTMulti
Pass ⚠Storage Create Deprecated VTMultiPassStorageandobjc2-core-media - VTPixel
Rotation ⚠Session Create Deprecated VTPixelRotationSession - VTPixel
Rotation ⚠Session Invalidate Deprecated VTPixelRotationSession - VTPixel
Rotation ⚠Session Rotate Image Deprecated VTPixelRotationSessionandobjc2-core-video - VTPixel
Transfer ⚠Session Create Deprecated VTPixelTransferSession - VTPixel
Transfer ⚠Session Invalidate Deprecated VTPixelTransferSession - VTPixel
Transfer ⚠Session Transfer Image Deprecated VTPixelTransferSessionandobjc2-core-video - VTRAW
Processing ⚠Session Complete Frames Deprecated VTRAWProcessingSession - VTRAW
Processing ⚠Session Copy Processing Parameters Deprecated VTRAWProcessingSession - VTRAW
Processing ⚠Session Create Deprecated VTRAWProcessingSessionandobjc2-core-media - VTRAW
Processing ⚠Session Invalidate Deprecated VTRAWProcessingSession - VTRAW
Processing ⚠Session Process Frame Deprecated block2andobjc2-core-videoandVTRAWProcessingSession - VTRAW
Processing ⚠Session SetParameter Changed Hander Deprecated VTRAWProcessingSessionandblock2 - VTRAW
Processing ⚠Session SetProcessing Parameters Deprecated VTRAWProcessingSession - VTRegister
Professional ⚠Video Workflow Video Decoders VTProfessionalVideoWorkflow - Allows the client to use video decoders appropriate for professional video workflows.
- VTRegister
Professional ⚠Video Workflow Video Encoders VTProfessionalVideoWorkflow - Allows the client to use encoders appropriate for professional video workflows.
- VTRegister
Supplemental ⚠Video Decoder IfAvailable VTUtilitiesandobjc2-core-media - Requests that a video decoder, if available, be registered for the specified CMVideoCodecType
- VTSession
Copy ⚠Property VTSession - Retrieves a property on a video toolbox session.
- VTSession
Copy ⚠Serializable Properties VTSession - Retrieves the set of serializable property keys and their current values.
- VTSession
Copy ⚠Supported Property Dictionary VTSession - Returns a dictionary enumerating all the supported properties of a video toolbox session.
- VTSession
SetProperties ⚠VTSession - Sets multiple properties at once.
- VTSession
SetProperty ⚠VTSession - Sets a property on a video toolbox session.
Type Aliases§
- VTCompression
Output Callback VTCompressionSessionandVTErrorsandobjc2-core-media - Prototype for callback invoked when frame compression is complete.
- VTCompression
Output Handler VTCompressionSessionandVTErrorsandblock2andobjc2-core-media - Prototype for block invoked when frame compression is complete.
- VTDecompression
Multi Image Capable Output Handler VTDecompressionSessionandVTErrorsandblock2andobjc2-core-mediaandobjc2-core-video - Prototype for block invoked when frame decompression is complete.
- VTDecompression
Output Callback VTDecompressionSessionandVTErrorsandobjc2-core-mediaandobjc2-core-video - Prototype for callback invoked when frame decompression is complete.
- VTDecompression
Output Handler VTDecompressionSessionandVTErrorsandblock2andobjc2-core-mediaandobjc2-core-video - Prototype for block invoked when frame decompression is complete.
- VTDecompression
Output Multi Image Callback VTDecompressionSessionandVTErrorsandobjc2-core-media - Prototype for callback invoked when multi-image frame decompression is complete.
- VTExtension
Properties Key VTUtilities - A key in a Media Extension extension properties dictionary.
- VTHDR
PerFrame Metadata GenerationHDR Format Type VTHDRPerFrameMetadataGenerationSession - Video Toolbox HDR Metadata Generation Session
- VTRAW
Processing Output Handler VTRAWProcessingSessionandblock2andobjc2-core-video - Block invoked when frame processing is complete.
- VTRAW
Processing Parameter Change Handler VTRAWProcessingSessionandblock2 - Block invoked when processing parameters change.
- VTSession
VTSession - A reference to either a Video Toolbox Decompression Session, Compression Session or Pixel Transfer Session.