Skip to main content

How do I use the Kaltura Integration?

Caption your content from Kaltura using Echo Labs integration

Elena avatar
Written by Elena
Updated over a week ago

Echo Labs' Kaltura Integration makes it simple to caption and add audio descriptions to your Kaltura content. To get started, you'll need to activate the Kaltura integration in your Echo Labs Account.
​

First, ensure that Kaltura is available under the integrations section of your Echo Labs Dashboard. If you don't see it listed, reach out to us at customersupport@el.ai, and we'll help you enable it.
​

You're now ready for setup. This includes three steps:
​

Step 1 - Create categories for Echo Labs

Make sure you are using an account with site-wide administrator permissions.
​

Default Setup (Root Category)

For most users, we recommend creating the Echo Labs category as a root category. This is the simplest setup path.

  1. From the Kaltura Management Console (KMC), in the "Content" section, click "Categories".

  2. Click "Add Category".

  3. Enter "Echo Labs" as the category name and leave the parent category as "No Parent Category". Click "Apply".

    KMC New Category dialog

  4. Take note of the category ID for the category you just created - this will be your Main Category ID.

    Categories page in KMC, with the ID of the Echo Labs category marked

Creating Subcategories for Different Ordering Options

If you want to use audio descriptions, you'll need to create subcategories under your main Echo Labs category. Each subcategory represents a different ordering option for your content.

  1. While still in the Categories section, click "Add Category" again.

  2. Create the following subcategories (as needed) under your main "Echo Labs" category:

    • "Echo Labs Captions Only" - For content that only needs captions

    • "Echo Labs AD (Standard Only)" - For standard audio description tracks

    • "Echo Labs AD (Extended Only)" - For extended audio description tracks

    • "Echo Labs AD (Separate Entry)" - For audio descriptions as separate media entries

  3. For each subcategory you create:

    • Select "Echo Labs" as the parent category

    • Click "Apply"

    • Take note of each category ID

Tree view of main Echo Labs category with subcategories expanded

Note: You only need to create subcategories for the ordering options you plan to use. If you don't need a particular type of audio description, you can skip creating that subcategory.

Optional Path 1: MediaSpace Channels Setup

If you want your Echo Labs categories to be available as MediaSpace channels:

  1. Instead of creating a root category, navigate to MediaSpace > site > channels in the category tree.

  2. Create your main "Echo Labs" category under "channels" as the parent category.

  3. Since MediaSpace has a privacy context, you'll need to configure entitlements:

    1. In the Entitlements section of your main category, click "Manage Users"

    2. Click "Add Users"

    3. In the "Select End-Users" box, enter "echolabsintegration" (without quotes) and press "Enter"

    4. Select "Contributor" as the permission level

    5. Click "Add 1 Users"

  4. Follow the steps in Creating Subcategories for Different Ordering Options. Repeat the entitlements configuration from above for each subcategory you create.

  5. Take note of the privacy context (it will be "MediaSpace").

Optional Path 2: Custom Privacy Context

If you're creating a root category but want to add privacy context for additional security:

  1. Follow the default setup.

  2. After creating your main Echo Labs category as a root category, go to the Settings page (gear icon in the top right of KMC).

  3. Navigate to the "Integrations" tab.

  4. Scroll down to the "Entitlement" section.

  5. Click "Add Entitlement"

  6. Select your main "Echo Labs" category from the dropdown.

  7. For "Add Privacy Context Label", enter "echolabs" (or your preferred label).

  8. Click "Apply"

  9. Now configure user access:

    1. Go back to your category in the Content > Categories section

    2. In the Entitlements section, click "Manage Users"

    3. Add "echolabsintegration" as a Contributor (same as MediaSpace setup)

    4. Repeat for all subcategories

Step 2 - Create a application token

In this section, you'll create a lesser-privileged application token for the Echo Labs platform to use.

Create a user role for the application token

  1. Navigate to Kaltura API Console > userRole.add

  2. Click "Sign in to execute".

  3. Enter your email and password, and click "Log In". In the popup, select your Kaltura account from the drop-down.

  4. Fill in the following information exactly (without quotes), and click "Send Request":

    • description: "Echo Labs Integration"

    • name: "Echo Labs Integration"

    • permissionNames: "CONTENT_MANAGE_BASE,CAPTION_MODIFY,CONTENT_INGEST_UPLOAD"

    • status: "ACTIVE[1]"
      ​


      ​

  5. Note down the value of the "id" field from the response. This is your role ID.

Create the application token

  1. Choose an expiry date for the token and convert it to a Unix timestamp. For example, 10 years in the future. You can use unixtimestamp.com to convert from a date to a Unix timestamp.

  2. Navigate to Kaltura API Console > appToken.add and fill in the following:

    • description: "Echo Labs App Token"

    • expiry: The timestamp from the previous step

    • hashType: "SHA256[SHA256]"

    • sessionType: "USER [0]"

    • sessionUserId: "echolabsintegration"

    • sessionPrivileges: (see below based on your setup)
      ​
      ​For Default Setup (Root Category without privacy context): "list:*,edit:*,setrole:<role ID>"
      Example: "list:*,edit:*,setrole:31104222"
      ​
      ​For MediaSpace Setup: "list:*,edit:*,setrole:<role ID>,privacycontext:MediaSpace"
      Example: "list:*,edit:*,setrole:31104222,privacycontext:MediaSpace"
      ​
      ​For Custom Privacy Context Setup: "list:*,edit:*,setrole:<role ID>,privacycontext:<your privacy context>"
      Example: "list:*,edit:*,setrole:31104222,privacycontext:echolabs"

  3. Click "Send Request" and take note of both the "id" and "token" fields in the response. These are your App Token ID and App Token.

Step 3 - Add your app token to Echo Labs

  1. In the KMC Settings > Integration page, take note of your Partner ID.

  1. Navigate to the Kaltura Integration tab in your Echo Labs account.

  2. Enter your credentials:

    • Partner ID

    • App Token ID

    • App Token

  3. Configure your categories:

    • Main Category ID: Enter the ID of your main Echo Labs category

    • Captions Only Category ID: Enter the ID of your "Echo Labs Captions Only" subcategory (optional)

    • AD Standard Only Category ID: Enter the ID of your "Echo Labs AD (Standard Only)" subcategory (optional)

    • AD Extended Only Category ID: Enter the ID of your "Echo Labs AD (Extended Only)" subcategory (optional)

    • AD Separate Entry Category ID: Enter the ID of your "Echo Labs AD (Separate Entry)" subcategory (optional)

    Important notes:

    • If you're using any audio description features, the Main Category ID is required

    • You only need to fill in the subcategory IDs for the ordering options you plan to use

  4. Click "Save".

Congratulations! You've successfully completed the Kaltura setup. You can now use the integration to caption and audio describe content on Kaltura using Echo Labs.

What's next?

For Echo Labs to process your content, simply add videos to the appropriate Echo Labs category based on what you need:

  • For captions only: Add to the "Echo Labs Captions Only" category (or the main category if you haven't set up subcategories)

  • For standard audio descriptions: Add to the "Echo Labs AD (Standard Only)" category

  • For extended audio descriptions: Add to the "Echo Labs AD (Extended Only)" category

  • For separate audio description entries: Add to the "Echo Labs AD (Separate Entry)" category

Adding content to categories

On the main "Entries" page of your Kaltura Management Console (KMC):

  1. Select the media entries you want to process

  2. Click "Actions" > "Categories"

  3. Add the appropriate Echo Labs category

  4. Click "Save"

Echo Labs will periodically check these categories and automatically import any new videos you add.

Once a video is processed, Echo Labs will update the corresponding entry in Kaltura with:

  • Captions

  • Audio description tracks (if requested)

You can monitor the status of imported videos on the "Kaltura" page of your Echo Labs dashboard. These videos will also appear in your main dashboard, just like videos uploaded through other methods.

Notes

  • Entries added to a audio description category will add captions as well

  • Entries cannot be added to more than one audio description category

Troubleshooting

If you encounter any issues:

  • Verify all category IDs are entered correctly

  • Ensure that the "echolabsintegration" user is added to each category (if using privacy context)

  • Check that your user role includes all three required permissions: CONTENT_MANAGE_BASE, CAPTION_MODIFY, and CONTENT_INGEST_UPLOAD

  • Contact customersupport@el.ai for assistance

Related Articles
How do I use the Canvas Studio Integration?
How do I use the Panopto Integration
Can I upload multiple files at once?
How do I use Analytics?
How many caption hours do I have left?
Did this answer your question?