Defining wizards for recorders and clients

You can define wizards for recorders and clients.

The New Recording Session wizard runs in the following sequence:

  1. The recording session file is selected.
  2. The client is selected.
  3. Optional: The recording method is selected.
  4. Optional: The client wizard pages are displayed.
  5. Optional: The recorder wizard pages are displayed.

Steps 4 and 5 can be combined in into a single step. Steps 4 and 5 are extension contributions.

Declare a wizard for each client and each recorder that you define. A client or a recorder that has no declared wizard is not available in the user interface and can be started only with a recording configuration file or programmatically.

When the New Recording Session wizard is complete, the wizard produces a recording session configuration that contains a client configuration and one or more recorder configurations. The recording session configuration is used to start a recording session and to instantiate the corresponding recorders and clients.

Several types of wizards can be defined, depending on how you have defined recorders and clients:

Additional information about the New Recording Session wizard:

To define a client wizard:

About the NewClientWizard class implementations:

To define a recorder wizard:

About NewRecordersWizard implementations:

To define a wizard that configures a client and one or more recorders altogether:

About NewRecorderClientWizard class implementations: