About
Use the player replacement tool to upgrade the default or custom players in your application from v2 to v7. You can use the default v7 player or enter a custom v7 player ID.
After the upgrade, the browser loads the v7 player directly from the server using its updated URL.
When to use this option
- You need to replace the default or custom players in your Content Hubs, legacy Video Portal, or LMS application.
- You want a simple way to upgrade your application players from v2 to v7.
Important to know
- The tool works like a “find and replace” for player IDs. It replaces v2 player IDs with v7 player IDs and doesn't affect other tools or embeds.
- The upgrade doesn't delete anything.
- You can back up your current player settings before replacing them. The tool saves one backup, which you can restore if needed.
- The tool isn't available for instances on the Regional Cloud.
Access the replacement tool
- Log in to your Configuration Management console.
- Click Server Tools, then select Player replacement tool.
The Replace player page displays.
On the left, the page shows a v7 player ID in the text box and a list of players to replace.
On the right, the page lists additional players that you can replace manually.
Preview
- Click Preview to preview the player ID in the text box.
- Select a demo video from the dropdown list, or enter part of its name in the search box. This example uses “Introduction.”
- Click Download current player list to save a file of your current player settings.
Replace players
Replace a predefined player
- Select the player to replace.
- Click Replace player.
Replace players with a custom v7 player
- Enter the custom v7 player ID in the text box.
- Select the players to replace.
- Click Replace player.
If the player ID isn't supported, this message appears: The player ID {player_ID} you entered is of a non-supported version. Replace player feature support V7 players only.
Back up and restore players
When you replace players, choose one of these actions:
- Backup & replace: Save your current player list and replace it with the new player ID. The tool keeps one backup.
- Replace without backup: Replace the player list without saving a backup.
A success message appears with the new player ID and the updated locations: Players replaced successfully!
To restore the previous players, click Review backup, then click Restore players.
Replace players manually
Some players aren't replaced automatically. You must update them in their own modules. These players appear in a separate list on the Replace player page. Select Go to module to open the corresponding module.
For instructions, see Manually replace your v2 players with v7 in your Kaltura application.
For more information about creating and customizing players, see Introduction to the Player Studio.
