Merge pull request #9 from docsforadobe/users/bbb/26.0_SDK

A flurry of general edits

Author: bbb999

docs/ae-transition-extensions/ae-transition-extensions.md

@@ -1,5 +1,5 @@
 # AE Transition Extensions
 
-This chapter describes how to build native transitions in Premiere Pro based on the After Effects API. From a user-perspective, plugins built this way can show their parameters directly in the Effect Controls panel, even providing custom parameter UI in that panel or in the Sequence Monitor. Such plugins can run not only in Premiere Pro, but also in After Effects, although they will appear as effects rather than transitions.
+This chapter describes how to build native transitions in Premiere Pro based on the After Effects API. From a user's perspective, plugins built this way can show their parameters directly in the Effect Controls panel, even providing custom parameter UI in that panel or in the Sequence Monitor. Such plugins can run not only in Premiere Pro, but also in After Effects, although they will appear as effects rather than transitions.
 
 The transition extensions work on top of effects built using the After Effects SDK. Since AE effects only have a single input, the second input is a layer parameter defined by the plugin.

docs/control-surfaces/control-surfaces.md

@@ -1,6 +1,6 @@
 # Control Surfaces
 
-Starting in Premiere Pro CC 2014, a control surface plugin can interface with a hardware control surface. This is the API that provides built-in support for EUCON and Mackie devices to control audio mixing and basic transport controls. The API supports two-way communication with Premiere Pro, so that hardware faders, VU meters, etc are in sync with the application.
+A control surface plugin can interface with a hardware control surface. This is the API that provides built-in support for EUCON and Mackie devices to control audio mixing and basic transport controls. The API supports two-way communication with Premiere Pro, so that hardware faders, VU meters, etc are in sync with the application.
 
 Compile the sample plugin into a subfolder of the main application folder: `Plugins\\ ControlSurface\\`
 
@@ -24,4 +24,4 @@ Then, CreatePluginInstance() is called. When a project is opened, Connect() is c
 
 ## Getting Started
 
-Please write us if you would like further guidance.
+Reach out as necessary, for further guidance.

docs/export-controllers/export-controllers.md

@@ -1,11 +1,9 @@
 # Export Controllers
 
-Starting in Premiere Pro 5.0.2, an export controller can drive any exporter to generate a file in any format and perform custom post-processing operations. Developers wanting to integrate Premiere Pro with an asset management system will want to use this API instead.
+An export controller can drive any exporter to generate a file in any format and perform custom post-processing operations. 
 
 An export controller adds its own custom menu item to the File > Export submenu. When the user chooses the menu item, the plugin is called with a TimelineID, which represents the current sequence. Although details on the current sequence are not passed in, the export controller can use the [Sequence Info Suite](../universals/sweetpea-suites.md#sequence-info-suite) to query for various properties. The export controller can then optionally display any custom modal UI to allow the user to set any parameters for the export.
 
-This UI will need to be provided by the export controller.
-
-The export controller should then call ExportFile in the Export Controller Suite, which takes the TimelineID, a path to an exporter preset, and a path for the output. This will tell Premiere Pro to handle the export, displaying progress. The call will return either a success value, an error, or that the user canceled. During the export, the UI will be blocked, just as when doing a standard export that doesn't use the Adobe Media Encoder Render Queue.
+The Export Controller must provide its own UI, calling ExportFile in the Export Controller Suite, which takes the TimelineID, a path to an exporter preset, and a path for the output. This tells Premiere Pro to handle the export, displaying progress. The call will return either a success value, an error, or that the user canceled. During the export, the UI will be blocked, just as when doing a standard export that doesn't use the Adobe Media Encoder Render Queue.
 
 Once Premiere Pro completes the export, the call will return to the export controller. The plugin can then perform any post-processing operations, such as transferring the newly exported file over the network, or registering the file in an asset management system.

docs/exporters/exporters.md

@@ -1,9 +1,5 @@
 # Exporters
 
-Exporters are used to export video, audio, and markers in any format. Exporters get individual video frames in a requested pixel format (generally, uncompressed video) and uncompressed audio. The exporter is responsible for any compression of the video and audio data, and wrapping the output in a file format. To reuse an existing exporter, you may provide an export controller.
+Exporters are used to export video, audio, and markers in any format. Exporters get individual video frames in a requested pixel format (generally, uncompressed video) and uncompressed audio. The exporter is responsible for any compression of the video and audio data, and wrapping the output in a file format.
 
-Exporters can be used from within Premiere Pro, or from Adobe Media Encoder. From within Premiere Pro, go to the File > Export > Media dialog. From there, the Export Settings dialog appears. The format chosen in the Format drop-down determines the exporter used, and the exporter provides the parameter settings and summary displayed in the Export Settings dialog.
-
-Exporters can optionally provide hardware acceleration by coordinating with a renderer plugin to render timeline segments. Legacy editing modes are formed by the combination of an exporter and a player; the exporter generates preview files and the player manages the cutlist.
-
-If you've never developed an exporter before, you can skip [Whats New](./whats-new.md), and go directly to [Getting Started](./getting-started.md).
+Exporters can be used from within Premiere Pro or Adobe Media Encoder. From within Premiere Pro, they are accessed via File > Export > Media. From there, the Export Settings dialog appears. The format chosen in the Format drop-down determines the exporter used, and the exporter provides the parameter settings and summary displayed in the Export Settings dialog.

docs/exporters/getting-started.md

@@ -78,15 +78,13 @@ In CS4, where the files are saved depends on whether you've opened the Export Se
 
 On Windows Vista, presets are saved here: `[User folder]\AppData\Roaming\Adobe\Adobe Media Encoder\[version]\Presets\\`
 
-On Windows XP: `[Documents and Settings folder]\[user name]\Application Data\\ Adobe\Adobe Media Encoder\[version]\Presets\\`
+On Windows XP: `[Documents and Settings folder]\[user name]\Application Data\Adobe\Adobe Media Encoder\[version]\Presets\\`
 
 On Mac OS: `~/Library/Preferences/Adobe/Adobe Media Encoder/[version]/ Presets/`
 
 ### Premiere Pro presets
 
-On Windows Vista, presets are saved here: `[User folder]\AppData\Roaming\Adobe\Premiere Pro\[version]\\ Presets\\`
-
-On Windows XP: `[Documents and Settings folder]\[user name]\Application Data\\ Adobe\Premiere Pro\[version]\Presets\\`
+On Windows, presets are saved here: `[User folder]\AppData\Roaming\Adobe\Premiere Pro\[version]\\ Presets\\`
 
 On Mac OS: `~/Library/Preferences/Adobe/Adobe Premiere Pro/[version]/Presets/`
 
@@ -98,18 +96,10 @@ For example, if you set it to: `<FolderDisplayPath>System Presets/Image Sequence
 
 It is essential to use: "System Presets/xxx/" where the xxx must be any of the existing main categories (use the English name for this). Only one level below can you can create a custom-named folder. If the folder doesn't already exist, it will be created.
 
-The Preset Browser data is cached in a file at: `[User Folder]\AppData\Roaming\Adobe\Common\AME\[version]\Presets\\ PresetTree.xml`
+The Preset Browser data is cached in a file at: `[User Folder]\AppData\Roaming\Adobe\Common\AME\[version]\Presets\PresetTree.xml`
 
 If you want to force a refresh of the Preset Browser data, just quit AME, delete this file, and re-launch AME.
 
-### Installation in CS4
-
-For better performance, in CS4, we recommend you install any presets for your exporter in the application folder for Premiere Pro and Media Encoder.
-
-For both Windows and Mac OS: `[App installation path]\MediaIO\systempresets\[exporter subfolder]`
-
-The subfolder must be named based on the hexadecimal fourCCs of the ClassID and filetype of the exporter. For example, the SDK exporter has a ClassID of 'DTEK' or 0x4454454B, and a filetype of `SDK` or 0x53444B5F. So the subfolder must be named '4454454B_53444B5F'. For convenience, you can find the ClassID and filetype fourCCs in the preset file itself, in a decimal representation.
-
 ---
 
 ## Parameter Caching
@@ -141,9 +131,7 @@ To support multichannel audio layouts, kPrAudioChannelType_MaxChannel should be
 
 The audio buffers you use for GetAudio() should likewise be an array of kPrAudioChannelType_MaxChannel channels, and yes, this means you may be allocating more space than actually used.
 
-In the exporter's Audio tab UI, you can provide a parameter to choose between various multi-channel audio layouts. You can compare your settings to what we have with the built-in formats, QuickTime and MXF (such as MXF OP1a and DNxHD). From the user selection in your audio export settings (e.g., 2x stereo, etc), you will know how many of those channels passed back in GetAudio() should actually be written to the file.
-
-Here's a helpful video on audio track mapping: [http://www.video2brain.com/en/lessons/changes-in-audio-tracks-and-merged-clip-audio](http://www.video2brain.com/en/lessons/changes-in-audio-tracks-and-merged-clip-audio)
+In the exporter's Audio tab, you can provide a parameter to choose between various multi-channel audio layouts. You can compare your settings to what we have with the built-in formats, QuickTime and MXF (such as MXF OP1a and DNxHD). From the user selection in your audio export settings (e.g., 2x stereo, etc), you will know how many of those channels passed back in GetAudio() should actually be written to the file.
 
 ---
 
@@ -161,48 +149,6 @@ Use a unique fileType for each format. When you are later sent `exSelGenerateDef
 
 ---
 
-## Exporters Used for Editing Modes
-
-An exporter that is used in an editing mode must have a codec parameter, and that parameter ID must be ADBEVideoCodec. If Premiere Pro cannot find this parameter, it will not be able to reopen projects in the custom editing mode, and will revert the project to Desktop mode.
-
-### Sequence Encoder Presets
-
-Sequence preview presets are now required for editing modes. These contain the exporter parameters to generate preview files. This makes preview file formats much easier to define, by using the Media Encoder or Premiere Pro UI to create presets, rather than directly editing XML.
-
-To create a sequence encoder preset:
-
-1. Create a preset. The name that you give it will be the name that will be used in the Sequence Settings > General > Preview File Format drop-down.
-2. Make sure this preset is installed in the application folder for Premiere Pro, along with the other sequence presets:
-
-On Windows, they should be installed here: `[App installation path]\Settings\EncoderPresets\SequencePreview\[editing mode GUID]*.epr`
-
-On MacOS, it is basically the same (inside the application package): `[App installation path]/[Premiere Pro package]/Contents/Settings/EncoderPresets/ SequencePreview/[editing mode GUID]/*.epr`
-
-As you can see by the installation paths above, Premiere Pro associates the sequence preview presets with the editing mode they go with, by using the presets in the folder that matches the GUID of the editing mode. The editing mode GUID is defined in the editing mode XML file, using the `<EditingMode.ID>` tag.
-
-### Adding new Preview File Formats to Existing Editing Modes
-
-You can not only provide sequence preview presets for your own editing mode, but you could even add additional sequence preview presets for one of the built-in editing modes. Editing mode GUIDs for built-in editing modes can be found in the Adobe Editing Modes. xml file. For example, the Desktop editing mode on Windows has the GUID 9678AF98A7B7-4bdb-B477-7AC9C8DF4A4E. On Mac OS it is 795454D9-D3C2-429d-9474- 923AB13B7018.
-
-You can additionally restrict the list and specify which one is chosen by default, by editing the `<PresetComments>` tag in the preset file.
-
-If the value of the tag starts with "IsConstrained,", then a comma delimited list of 4ccs follows that dictates which codecs are available, and the first one is chosen by default.
-
-For example, QuickTime DV NTSC.epr for the Mac DV NTSC editing mode has this: `<PresetComments>IsConstrained,dvc </PresetComments>`
-
-Which restricts the codec selection of the exporter to be only the single codec choice.
-
----
-
-## Stereoscopic Video
-
-!!! note
-    Currently stereoscopic exporters must use the old "pull" model, and only receive stereoscopic video when exporting directly from Premiere Pro. In other words, when exports are queued to run in Adobe Media Encoder, they will not get stereoscopic video.
-
-To get rendered frames for both left and right eye, use the [Video Segment Suite](../universals/sweetpea-suites.md#video-segment-suite) to request the left and right cutlists, and render frames from both. An exporter can tell if segments in both of them are identical (implying that they have nothing stereoscopic about them) by looking at the segment hashes, and you can tell if two frames are identical (by looking at the request identifiers).
-
----
-
 ## Timeline Segments in Exporters
 
 The timeline segments available to exporters do not always fully describe the sequence being exported. To consistently get timeline segments that fully describe the sequence, an exporter needs to work along with a renderer plugin.

docs/exporters/whats-new.md

@@ -1,6 +1,6 @@
 # Whats New
 
-## What's New in CC
+## What's New in CC (7.0)
 
 A new Captions tab has been added to the Export Settings, for Closed Captioning export. For all formats, a sidecar file containing the captions can be exported.
 

docs/gpu-effects-transitions/getting-started.md

@@ -4,7 +4,7 @@
 
 If you are developing an effect, begin with one of the two GPU effect sample projects, progressively replacing its functionality with your own. Refer to [Introduction](../index.md) for general instructions on how to build the SDK projects.
 
-In addition to those general instructions, the sample project is also dependent on the After Effects plugin SDK. On Windows, create an environment variable pointing to it named AE_SDK_BASE_PATH, so that the compiler will find the AE headers that the project includes. On macOS, in *Xcode > Preferences > Locations > Custom Paths*, specify AE_SDK_BASE_PATH to be the root folder of the AE plugin SDK you have downloaded and unzipped.
+In addition to those general instructions, the sample project is also dependent on the After Effects plugin SDK. On Windows, create an environment variable pointing to it named AE_SDK_BASE_PATH, so that the compiler will find the AE headers that the project includes. On macOS, in *XCode > Preferences > Locations > Custom Paths*, specify AE_SDK_BASE_PATH to be the root folder of the AE plugin SDK you have downloaded and unzipped.
 
 The samples also use Boost, which may be downloaded at boost.org. Download that, and create a variable named BOOST_BASE_PATH just as you did with AE_SDK_BASE_PATH above.
 

docs/hardware/hardware-integration-components.md

@@ -6,12 +6,6 @@ Importers are used whenever frames of video or audio from a clip are needed. To
 
 ---
 
-## Recorders
-
-Users may choose a recorder in Project > Project Settings > General > Capture Format. Recorders are used to grab frames from a hardware source and write them to a file, to be imported for editing.
-
----
-
 ## Exporters
 
 Exporters are used whenever Premiere Pro renders preview files, or performs an export on a clip or sequence. To give Premiere Pro the ability to write media that uses a new format or codec, develop an exporter. The exporter used to render preview files in the timeline is set in Sequence > Sequence Settings > Preview File Format. The exporter used for exports is chosen when the user selects File > Export > Media > File Type. See [Exporters](../exporters/exporters.md) for more information.

docs/hardware/hardware.md

@@ -1,11 +1,7 @@
 # Hardware
 
-To integrate hardware with Premiere Pro, you may consider developing up to five types of plugins:
+To integrate hardware with Premiere Pro, you may consider three types of plugins:
 
 - importers,
-- recorders,
 - exporters,
-- transmitters, and
-- device controllers
-
-Premiere Pro provides the user interface for the capture, timeline, monitor, and export panels; the plugins provide the functionality behind the interface.
+- transmitters

docs/history.md

@@ -2,7 +2,7 @@
 
 |       Date        |         Maintainer          |               Version               |
 | ----------------- | --------------------------- | ----------------------------------- |
-| 23 Oct 2023       | Bruce Bullis                | Version 24.0                        |
+| 23 Oct 2025       | Bruce Bullis                | Version 26.0                        |
 | 6 Oct 2021        | Sanaz Golbabaei             | Version 22.0                        |
 | 8 May 2020        | Bruce Bullis                | Version 14.2                        |
 | 1 May 2019        | Bruce Bullis                | Version 13.1                        |