MBS Avfoundation Plugin.Pdf
Total Page：16
File Type：pdf, Size：1020Kb
MBS AVFoundation Plugin Documentation Christian Schmitz September 6, 2021 2 0.1 Introduction This is the PDF version of the documentation for the Xojo Plug-in from Monkeybread Software Germany. Plugin part: MBS AVFoundation Plugin 0.2 Content • 1 List of all topics 3 • 2 List of all classes 111 • 3 List of all controls 119 • 4 All items in this plugin 121 • 10 List of Questions in the FAQ 1191 • 11 The FAQ 1201 Chapter 1 List of Topics • 4 AVFoundation 121 – 4.1.1 class AVAssetExportSessionMBS 121 ∗ 4.1.5 allExportPresets as string() 122 ∗ 4.1.6 available as boolean 123 ∗ 4.1.7 AVAssetExportPreset1280x720 as string 123 ∗ 4.1.8 AVAssetExportPreset1920x1080 as string 123 ∗ 4.1.9 AVAssetExportPreset3840x2160 as string 123 ∗ 4.1.10 AVAssetExportPreset640x480 as string 123 ∗ 4.1.11 AVAssetExportPreset960x540 as string 124 ∗ 4.1.12 AVAssetExportPresetAppleM4A as string 124 ∗ 4.1.13 AVAssetExportPresetAppleM4V1080pHD as string 124 ∗ 4.1.14 AVAssetExportPresetAppleM4V480pSD as string 124 ∗ 4.1.15 AVAssetExportPresetAppleM4V720pHD as string 124 ∗ 4.1.16 AVAssetExportPresetAppleM4VAppleTV as string 124 ∗ 4.1.17 AVAssetExportPresetAppleM4VCellular as string 125 ∗ 4.1.18 AVAssetExportPresetAppleM4ViPod as string 125 ∗ 4.1.19 AVAssetExportPresetAppleM4VWiFi as string 125 ∗ 4.1.20 AVAssetExportPresetAppleProRes422LPCM as string 125 ∗ 4.1.21 AVAssetExportPresetHEVC1920x1080 as string 125 ∗ 4.1.22 AVAssetExportPresetHEVC3840x2160 as string 126 ∗ 4.1.23 AVAssetExportPresetHEVCHighestQuality as string 126 ∗ 4.1.24 AVAssetExportPresetHighestQuality as string 126 ∗ 4.1.25 AVAssetExportPresetLowQuality as string 126 ∗ 4.1.26 AVAssetExportPresetMediumQuality as string 127 ∗ 4.1.27 AVAssetExportPresetPassthrough as string 127 ∗ 4.1.28 cancelExport 127 ∗ 4.1.29 Constructor(asset as AVAssetMBS, presetName as string) 127 3 4 CHAPTER 1. LIST OF TOPICS ∗ 4.1.30 determineCompatibilityOfExportPreset(presetName as string, asset as AVAssetMBS, outputFileType as string, tag as Variant = nil) 128 ∗ 4.1.31 determineCompatibleFileTypes(tag as Variant = nil) 128 ∗ 4.1.32 exportAsynchronously(tag as Variant = nil) 129 ∗ 4.1.33 exportMT 130 ∗ 4.1.34 exportPresetsCompatibleWithAsset(asset as AVAssetMBS) as string() 130 ∗ 4.1.35 exportSessionWithAsset(asset as AVAssetMBS, presetName as string) as AVAssetEx- portSessionMBS 131 ∗ 4.1.36 metadata as AVMetadataItemMBS() 131 ∗ 4.1.37 outputFileExtension as string 131 ∗ 4.1.38 setMetadata(items() as AVMetadataItemMBS) 132 ∗ 4.1.39 supportedFileTypes as string() 132 ∗ 4.1.41 asset as AVAssetMBS 133 ∗ 4.1.42 audioMix as AVAudioMixMBS 133 ∗ 4.1.43 audioTimePitchAlgorithm as String 133 ∗ 4.1.44 canPerformMultiplePassesOverSourceMediaData as Boolean 133 ∗ 4.1.45 customVideoCompositor as AVVideoCompositingMBS 134 ∗ 4.1.46 directoryForTemporaryFiles as FolderItem 134 ∗ 4.1.47 directoryForTemporaryFilesURL as String 135 ∗ 4.1.48 error as NSErrorMBS 136 ∗ 4.1.49 estimatedOutputFileLength as Int64 136 ∗ 4.1.50 Handle as Integer 136 ∗ 4.1.51 metadataItemFilter as AVMetadataItemFilterMBS 136 ∗ 4.1.52 OutputFile as folderitem 137 ∗ 4.1.53 outputFileType as string 137 ∗ 4.1.54 outputURL as string 137 ∗ 4.1.55 presetName as string 137 ∗ 4.1.56 progress as Double 137 ∗ 4.1.57 shouldOptimizeForNetworkUse as boolean 138 ∗ 4.1.58 status as Integer 138 ∗ 4.1.59 videoComposition as AVVideoCompositionMBS 138 ∗ 4.1.60 timeRange as CMTimeRangeMBS 138 ∗ 4.1.62 AVAssetExportSessionStatusCancelled = 5 139 ∗ 4.1.63 AVAssetExportSessionStatusCompleted = 3 139 ∗ 4.1.64 AVAssetExportSessionStatusExporting = 2 139 ∗ 4.1.65 AVAssetExportSessionStatusFailed = 4 140 ∗ 4.1.66 AVAssetExportSessionStatusUnknown = 0 140 ∗ 4.1.67 AVAssetExportSessionStatusWaiting = 1 140 – 4.2.1 class AVAssetImageGeneratorMBS 141 ∗ 4.2.5 assetImageGeneratorWithAsset(asset as AVAssetMBS) as AVAssetImageGeneratorMBS 141 ∗ 4.2.6 available as boolean 142 5 ∗ 4.2.7 AVAssetImageGeneratorApertureModeCleanAperture as string 142 ∗ 4.2.8 AVAssetImageGeneratorApertureModeEncodedPixels as string 142 ∗ 4.2.9 AVAssetImageGeneratorApertureModeProductionAperture as string 142 ∗ 4.2.10 cancelAllCGImageGeneration 142 ∗ 4.2.11 CGImageAtTime(time as CMTimeMBS, byref actualTime as CMTimeMBS, byref er- ror as NSErrorMBS) as Variant 143 ∗ 4.2.12 Constructor(asset as AVAssetMBS) 143 ∗ 4.2.13 generateCGImagesAsynchronouslyForTimes(times() as CMTimeMBS, tag as Variant = nil) 144 ∗ 4.2.15 apertureMode as string 144 ∗ 4.2.16 appliesPreferredTrackTransform as boolean 144 ∗ 4.2.17 asset as AVAssetMBS 145 ∗ 4.2.18 customVideoCompositor as AVVideoCompositingMBS 145 ∗ 4.2.19 Handle as Integer 145 ∗ 4.2.20 videoComposition as AVVideoCompositionMBS 146 ∗ 4.2.21 maximumSize as CGSizeMBS 146 ∗ 4.2.22 requestedTimeToleranceAfter as CMTimeMBS 146 ∗ 4.2.23 requestedTimeToleranceBefore as CMTimeMBS 146 ∗ 4.2.25 AVAssetImageGeneratorCancelled = 2 147 ∗ 4.2.26 AVAssetImageGeneratorFailed = 1 147 ∗ 4.2.27 AVAssetImageGeneratorSucceeded = 0 147 – 4.3.1 class AVAssetMBS 148 ∗ 4.3.7 assetWithData(Data as MemoryBlock, Options as Dictionary = nil) as AVAssetMBS 149 ∗ 4.3.8 assetWithData(Data as String, Options as Dictionary = nil) as AVAssetMBS 150 ∗ 4.3.9 assetWithFile(file as folderitem) as AVAssetMBS 151 ∗ 4.3.10 assetWithURL(URL as string) as AVAssetMBS 151 ∗ 4.3.11 available as boolean 151 ∗ 4.3.12 availableChapterLocales as NSLocaleMBS() 151 ∗ 4.3.13 availableMediaCharacteristicsWithMediaSelectionOptions as string() 151 ∗ 4.3.14 availableMetadataFormats as string() 152 ∗ 4.3.15 cancelLoading 152 ∗ 4.3.16 chapterMetadataGroupsBestMatchingPreferredLanguages as AVTimedMetadataGroupMBS() 152 ∗ 4.3.17 chapterMetadataGroupsBestMatchingPreferredLanguages(preferredLanguages() as string) as AVTimedMetadataGroupMBS() 153 ∗ 4.3.18 chapterMetadataGroupsWithTitleLocale(locale as NSLocaleMBS, commonKeys() as string) as AVTimedMetadataGroupMBS() 154 ∗ 4.3.19 commonMetadata as AVMetadataItemMBS() 154 ∗ 4.3.20 Constructor 155 ∗ 4.3.21 copy as AVAssetMBS 155 ∗ 4.3.22 duration as CMTimeMBS 155 6 CHAPTER 1. LIST OF TOPICS ∗ 4.3.23 loadValuesAsynchronouslyForKeys(keys() as string, tag as Variant = nil) 155 ∗ 4.3.24 mediaSelectionGroupForMediaCharacteristic(mediaCharacteristic as string) as AVMe- diaSelectionGroupMBS 157 ∗ 4.3.25 metadata as AVMetadataItemMBS() 157 ∗ 4.3.26 metadataForFormat(Format as string) as AVMetadataItemMBS() 158 ∗ 4.3.27 naturalSize as CGSizeMBS 158 ∗ 4.3.28 preferredTransform as CGAffineTransformMBS 159 ∗ 4.3.29 readTimeCodeObjects as AVTimeCodeMBS() 159 ∗ 4.3.30 readTimeCodes as String() 159 ∗ 4.3.31 statusOfValueForKey(key as string, byref error as NSErrorMBS) as Integer 160 ∗ 4.3.32 trackGroups as AVAssetTrackGroupMBS() 161 ∗ 4.3.33 tracks as AVAssetTrackMBS() 161 ∗ 4.3.34 tracksWithMediaCharacteristic(mediaCharacteristic as string) as AVAssetTrackMBS() 161 ∗ 4.3.35 tracksWithMediaType(mediaType as string) as AVAssetTrackMBS() 161 ∗ 4.3.36 trackWithTrackID(PersistentTrackID as Integer) as AVAssetTrackMBS 162 ∗ 4.3.37 unusedTrackID as Integer 162 ∗ 4.3.39 ClassName as String 162 ∗ 4.3.40 creationDate as AVMetadataItemMBS 163 ∗ 4.3.41 Handle as Integer 163 ∗ 4.3.42 hasProtectedContent as boolean 163 ∗ 4.3.43 isComposable as boolean 163 ∗ 4.3.44 isExportable as boolean 164 ∗ 4.3.45 isPlayable as boolean 164 ∗ 4.3.46 isReadable as boolean 164 ∗ 4.3.47 lyrics as string 164 ∗ 4.3.48 preferredRate as Double 165 ∗ 4.3.49 preferredVolume as Double 165 ∗ 4.3.50 providesPreciseDurationAndTiming as boolean 165 ∗ 4.3.51 referenceRestrictions as Integer 165 ∗ 4.3.53 AVAssetReferenceRestrictionForbidAll = & hFFFF 166 ∗ 4.3.54 AVAssetReferenceRestrictionForbidCrossSiteReference = 4 166 ∗ 4.3.55 AVAssetReferenceRestrictionForbidLocalReferenceToLocal = 8 166 ∗ 4.3.56 AVAssetReferenceRestrictionForbidLocalReferenceToRemote = 2 166 ∗ 4.3.57 AVAssetReferenceRestrictionForbidNone = 0 167 ∗ 4.3.58 AVAssetReferenceRestrictionForbidRemoteReferenceToLocal = 1 167 ∗ 4.3.59 AVKeyValueStatusCancelled = 4 167 ∗ 4.3.60 AVKeyValueStatusFailed = 3 167 ∗ 4.3.61 AVKeyValueStatusLoaded = 2 167 ∗ 4.3.62 AVKeyValueStatusLoading = 1 168 ∗ 4.3.63 AVKeyValueStatusUnknown = 0 169 – 4.4.1 class AVAssetReaderAudioMixOutputMBS 170 7 ∗ 4.4.3 assetReaderAudioMixOutputWithAudioTracks(audioTracks() as AVAssetTrackMBS, out- putSettings as dictionary) as AVAssetReaderAudioMixOutputMBS 170 ∗ 4.4.4 audioSettings as dictionary 170 ∗ 4.4.5 audioTracks as AVAssetTrackMBS() 171 ∗ 4.4.6 Constructor(audioTracks() as AVAssetTrackMBS, outputSettings as dictionary) 171 ∗ 4.4.8 audioMix as AVAudioMixMBS 171 ∗ 4.4.9 audioTimePitchAlgorithm as String 172 – 4.5.1 class AVAssetReaderMBS 173 ∗ 4.5.3 addOutput(output as AVAssetReaderOutputMBS) 173 ∗ 4.5.4 asset as AVAssetMBS 173 ∗ 4.5.5 assetReaderWithAsset(item as AVAssetMBS, byref error as NSErrorMBS) as AVAsse- tReaderMBS 174 ∗ 4.5.6 available as boolean 174 ∗ 4.5.7 canAddOutput(output as AVAssetReaderOutputMBS) as boolean 174 ∗ 4.5.8 cancelReading 174 ∗ 4.5.9 Constructor(item as AVAssetMBS, byref error as NSErrorMBS) 175 ∗ 4.5.10 error as NSErrorMBS 175 ∗ 4.5.11 outputs as AVAssetReaderOutputMBS() 175 ∗ 4.5.12 startReading 175 ∗ 4.5.13 status as Integer 176 ∗ 4.5.15 Handle as Integer 176 ∗ 4.5.16 timeRange as CMTimeRangeMBS 176 ∗ 4.5.18 AVAssetReaderStatusCancelled = 4 177 ∗ 4.5.19 AVAssetReaderStatusCompleted = 2 177 ∗ 4.5.20 AVAssetReaderStatusFailed = 3 177 ∗ 4.5.21 AVAssetReaderStatusReading = 1 177 ∗ 4.5.22 AVAssetReaderStatusUnknown = 0 177 – 4.6.1 class AVAssetReaderOutputMBS 178 ∗ 4.6.3 available as boolean 178 ∗ 4.6.4 Constructor 178 ∗ 4.6.5 NextSampleBuffer as CMSampleBufferMBS 178 ∗ 4.6.7 alwaysCopiesSampleData