旧版回调套件
piSuites
这些回调适用于所有插件，尽管其中许多回调仅适用于特定类型的插件。
PlugMemoryFuncsPtr memFuncs;
PlugWindowFuncsPtr windFuncs;
PlugppixFuncsPtr ppixFuncs;
PlugUtilFuncsPtr utilFuncs;
PlugTimelineFuncsPtr timelineFuncs;
} piSuites, *piSuitesPtr;
| 成员 | 描述 |
|---|
piInterfaceVer | API 版本 |
| - Premiere Pro CS4 - PR_PISUITES_VERSION_9 |
| - Premiere Pro CS3 - PR_PISUITES_VERSION_8 |
| - Premiere Pro 2.0 - PR_PISUITES_VERSION_7 |
| - Premiere Pro 1.5.1 - PR_PISUITES_VERSION_6 |
| - Premiere Pro 1.5 - PR_PISUITES_VERSION_5 |
| - Premiere Pro 1.0 - PR_PISUITES_VERSION_4 |
| - Premiere 6.x - PR_PISUITES_VERSION_3 |
| - Premiere 5.1 - PR_PISUITES_VERSION_2 |
| - Premiere 5.0 - PR_PISUITES_VERSION_1 |
| memfuncs | 指向内存函数的指针 |
| windFuncs | 指向窗口函数的指针 |
| ppixFuncs | 指向 PPix 函数的指针 |
| utilFuncs | 指向实用函数的指针。 |
| 在 utilFuncs 中，getSPBasicSuite 回调提供了对 SweetPea 套件 的访问，这些套件用于大多数新功能。 |
| timelineFuncs | 指向时间轴函数的指针 |
内存函数
内存和句柄分配。如果可能，请使用 PPix 创建器套件 进行 PPix 特定的分配。
在 API 结构中传递给 Premiere 和从 Premiere 传递的字符串始终是以 null 结尾的 C 字符串。
| 函数 | 描述 |
|---|
newPtr | 分配一块内存，返回指向新块的指针。 |
| char* newPtr (csSDK_uint32 size); |
newPtrClear | 等同于 newPtr，但将内存初始化为 0。 |
| char* newPtrClear (csSDK_uint32 size); |
setPtrSize | 调整已分配内存块的大小。 |
| void setPtrSize (
PrMemoryPtr *ptr,
csSDK_uint32 newsize); |
getPtrSize | 返回已分配内存块的大小（以字节为单位）。 |
| csSDK_int32 getPtrSize (char *ptr); |
disposePtr | 释放已分配的内存块。 |
| void disposePtr (char *ptr); |
newHandle | 分配一块内存，返回其句柄。 |
| char** newHandle (csSDK_uint32 size); |
newHandleClear | 等同于 newHandle，但将内存初始化为 0。 |
| char** newHandleClear (csSDK_uint32 size); |
setHandleSize | 调整已分配内存句柄的大小。 |
| csSDK_int16 setHandleSize (
char **PrMemoryHandle,
csSDK_uint32 newsize); |
getHandleSize | 返回已分配块的大小（以字节为单位）。 |
| csSDK_int32 getHandleSize ( char **PrMemoryHandle); |
disposeHandle | 释放先前分配的句柄。 |
| void disposeHandle (char **PrMemoryHandle); |
lockHandle unlockHandle | 这些旧版函数已弃用，不应再使用。 |
窗口函数
窗口管理例程。已被 窗口套件 取代。
| 函数 | 描述 |
|---|
updateAllWindows | 更新所有窗口。仅适用于 Windows，不适用于 Mac OS。 |
| void updateAllWindows (void); |
getMainWnd | 返回主应用程序的 HWND。 |
| void getMainWnd (void); |
PPix 函数
用于操作 PPix。已被 PPix 创建器套件 取代用于 PPix 分配，并被 PPix 套件 取代用于一般 PPix 函数。
| 函数 | 描述 |
|---|
ppixGetPixels | 返回 PPix 中包含的像素数组的指针。 |
| char* ppixGetPixels (PPixHand pix); |
ppixGetBounds | 返回 PPix 的边界。 |
| void ppixGetBounds (
PPixHand pix;
prRect *bounds); |
ppixGetRowbytes | 返回 PPix 的行字节数，以便正确解析由 ppixGetPixels 返回的像素。 |
| int ppixGetRowbytes (PPixHand pix); |
ppixNew | 分配并返回一个新的 PPix 的句柄，具有指定的边界。 |
| 由于这是一个较旧的调用，像素格式硬编码为 BGRA_4444_8u。 |
| PPixHandle ppixNew (prRect *bounds); |
ppixDispose | 释放 PPixHand。 |
| void ppixDispose (PPixHand pix); |
ppixLockPixels ppixUnlockPixels | 这些旧版函数已弃用，不应再使用。 |
ppixGetPixelAspectRatio | 传递回 PPixHand 的像素宽高比。 |
| Premiere 使用 PAR 分子和分母填充 longs。 |
| int ppixGetPixelAspectRatio (
PPixHand pix,
csSDK_uint32 *num,
csSDK_uint32 *den) |
ppixGetAlphaBounds | 传递回 PPixHand 的 alpha 边界。 |
| void ppixGetAlphaBounds (
PPixHand pix,
prRect *alphaBounds) |
实用函数
| 函数 | 描述 |
|---|
getSerialNumber | 传递回 Premiere 的序列号。 |
| void getSerialNumber (char* buffer); |
| - buffer: 必须至少为 40 个字符长。 |
getFileTimebase | 传递回文件的时基，使用 TDB_TimeRecord（由插件分配）。 |
| 如果文件已经在序列中，最好使用 视频片段套件 获取文件的时基，以获取 kVideoSegmentProperty_Media_StreamFrameRate。 |
| 注意：了解你的格式。不要向仅音频格式请求视频，否则可能会得到意外的结果。 |
| csSDK_int32 getFileTimebase (
prFileSpec *filespec,
csSDK_int32 audioOnly,
TDB_TimeRecord *result); |
| - filespec: 文件的描述，使用 getFileVideo 之前 |
| - audioOnly: 如果非零，返回音频时基。如果为零，返回视频时基。 |
| - result: 返回的时基 |
getFileVideo | 从文件中获取一帧视频（在指定时间）。 |
| 如果文件已经在序列中，最好使用 剪辑渲染套件 获取文件的视频。 |
| csSDK_int32 getFileVideo (
prFileSpec *filespec,
csSDK_int32 frame,
PPixHand thePort,
prRect *bounds,
csSDK_int32 flags); |
| - filespec: 文件的描述 |
| - frame: 要检索的帧 |
| - thePort: 帧将传递到的位置，调用前分配 |
| - bounds: 端口的边界 |
| - flags: 未使用 |
getFileVideoBounds | 传递回文件的边界。 |
| 如果文件已经在序列中，最好使用 剪辑渲染套件 获取文件的视频边界。 |
| csSDK_int32 getFileVideoBounds (
prFileSpec *filespec,
prRect *bounds); |
getSPBasicSuite | 这个非常重要的调用返回 SweetPea 套件，允许插件获取和释放所有其他 SweetPea 套件。 |
| SPBasicSuite* getSPBasicSuite(); |
getFileExtString | 传递回给定媒体类别的有效扩展名/过滤器字符串列表（见下面的文件类型常量）。 |
| csSDK_int32 (*plugGetFileExtStringFunc)(
csSDK_uint32 fileTypes,
char *inBuffer,
csSDK_uint32 inBufferSize); |
| - kFileTypes_Still: 静态媒体 |
| - kFileTypes_AudioOnly: 仅音频媒体 |
| - kFileTypes_AudioVideo: 音频和视频媒体 |
| - kFileTypes_AllNoIntrinsics: 所有可通过导入插件导入的媒体类型（不包括 prproj、txt 等） |
时间轴函数
| 函数 | 描述 |
|---|
getClipVideo | 已被 剪辑渲染套件 取代，后者提供异步导入。 |
| 从 视频片段套件 返回的片段树中检索剪辑中的一帧。 |
| 它可以用于检索和存储静止帧，例如标题，用于播放。 |
| !!! 警告 |
| 此调用开销较大；请谨慎使用。 |
| csSDK_int32 getClipVideo (
csSDK_int32 frame,
PPixHand thePort,
prRect *bounds,
csSDK_int32 flags,
PrClipID clipData); |
| - frame: 你请求的帧号 |
| - thePort: 使用 PPix 创建器套件 分配 |
| - bounds: 要返回的视频边界 |
| - flags: 要么是 kGCVFlag_UseFilePixelAspectRatio 要么是 0。设置为 kGCVFlag_UseFilePixelAspectRatio 将返回一个带有文件 PAR 的 PPix。设置为 0 将返回一个调整为项目 PAR 的 PPix，并相应地标记。它会缩放，但不会拉伸 PPix 以适应传入的目标 PPix。因此，如果目标 PPix 大于请求的帧，帧将保持其帧宽高比，用透明黑色填充帧。要以其原始尺寸导入帧，请使用 getClipVideoBounds，使用返回的尺寸分配目标 PPix，并将 PPixHand 和尺寸传递给 getClipVideo。如果帧尺寸与序列尺寸不同，帧必须由插件在合成中定位。 |
| - clipData: 在 prtFileRec 中找到的 clipData 句柄 |
getWorkArea | 传递回两个 longs，表示当前工作区域的开始和结束（只读）。 |
| 将 timelineData 设置为当前序列的 timelineData。 |
| csSDK_int32 getWorkArea (
PrTimelineID timelineData,
csSDK_int32 *workAreaStart,
csSDK_int32 *workAreaEnd); |
getCurrentTimebase | 传递回时间轴的当前时基（scale + sampleSize）。 |
| void getCurrentTimebase(
PrTimelineID timelineData,
csSDK_uint32 *scale,
csSDK_int32 *sampleSize); |
| - timelineData: 当前序列的 timelineData |
| - scale: 序列比例 |
| - sampleSize: 序列样本大小 |
getCurrentPos | 返回当前时间指示器的位置（用户设置的位置栏）。 |
| 如果返回 (-1)，时间轴中的位置栏不存在。 |
| csSDK_int32 getCurrentPos(
PrTimelineID timelineData); |
| - timelineData: 当前序列的 timelineData |
getPreviewFrameEx | 从时间轴获取完全渲染的帧（所有层）。 |
| 用于视频滤镜和过渡在模态设置对话框中的预览。 |
| 如果返回值为 -1，则发生错误，但如果为 0，则回调已安全返回。 |
| 导出器渲染最终电影时不应使用此回调。 |
| csSDK_int32 getPreviewFrameEx(
PrTimelineID timelineData,
csSDK_int32 inFrame,
PPixHand* outRenderedFrame,
const prRect* inFrameRect,
PrPixelFormat* inRequestedPixelFormatArray,
csSDK_int32 inRequestedPixelFormatArrayCount,
csSDK_uint32 inPixelAspectRatioNumerator,
csSDK_uint32 inPixelAspectRatioDenominator,
bool inAlwaysRender); |
| - timelineData: 当前序列的 timelineData。传递 EffectRecord、VideoRecord、compDoCompileInfo 或 imGetPrefsRec 中提供的时间轴句柄。 |
| - inFrame: 要获取的帧 |