Class VideoService

A model for the managed image service.

Hierarchy (View Summary)

ManagedServiceModel
- VideoService

Index

Constructors

constructor

new VideoService(
    page: Page,
    uiShell: UiShellModel,
    uiManagedWorkflows: UiWorkflowsModel,
): VideoService
Parameters
- page: Page
  The playwright page object.
- uiShell: UiShellModel
  A model representing the Mosaic UI shell including methods for navigation.
  
  Use this model to interact with:
  
  The breadcrumbs bar (on any page)
  
  The landing page
  
  The settings hub page
- uiManagedWorkflows: UiWorkflowsModel
  A model representing Mosaic UI workflows.
  
  Use this model to interact with workflows or modals of any managed service (Image, Video, etc).
Returns VideoService
Inherited from ManagedServiceModel.constructor

Properties

`Protected` `Readonly`page

page: Page

The playwright page object.

`Protected` `Readonly`uiManagedWorkflows

uiManagedWorkflows: UiWorkflowsModel

A model representing Mosaic UI workflows.

Use this model to interact with workflows or modals of any managed service (Image, Video, etc).

`Protected` `Readonly`uiShell

uiShell: UiShellModel

A model representing the Mosaic UI shell including methods for navigation.

Use this model to interact with:

The breadcrumbs bar (on any page)
The landing page
The settings hub page

Methods

approveVideo

approveVideo(args: { title: string }): Promise<void>
This method approves a video by title. The management system must be loaded & signed in before using this method. If a single matching, non-archived video is not found then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Videos' tile
- Filter by title and verify that a single result is shown
- Navigate to the video with the row action
- Click 'Preview' then set the status to 'Approved'
- Click the 'previous' breadcrumb and wait for the video details station to load
Parameters
- args: { title: string }
  - title: string
    A unique video title.
Returns Promise<void>

archiveVideo

archiveVideo(args: { title: string }): Promise<void>
This method archives a video by title. The management system must be loaded & signed in before using this method. If a single matching, non-archived video is not found then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Videos' tile
- Filter by title and verify that a single result is shown
- Navigate to the video with the row action
- Click 'Archive' and confirm
- Wait for the video details station to reload
Parameters
- args: { title: string }
  - title: string
    A unique video title.
Returns Promise<void>

createVideoProcessingProfile

createVideoProcessingProfile(
    properties: {
        drmProtection?: "Single Key" | "Multiple Keys";
        outputFormat:
            | "HLS"
            | "DASH"
            | "DASH & HLS"
            | "CMAF"
            | "DASH On Demand"
            | "MPEG-2 TS";
        title: string;
    },
): Promise<void>
This method creates a video processing profile. The management system must be loaded & signed in before using this method.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Settings' tile
- Navigate to the 'Video Encoding', 'Processing' tile
- Click the 'New' action
- Enter values for 'Title' and 'Output Format'
- Click the 'Proceed' action
- Enter the value for 'DRM Protection' (if provided)
- Click the 'previous' breadcrumb and wait for the explorer station to load
Parameters
- properties: {
      drmProtection?: "Single Key" | "Multiple Keys";
      outputFormat:
          | "HLS"
          | "DASH"
          | "DASH & HLS"
          | "CMAF"
          | "DASH On Demand"
          | "MPEG-2 TS";
      title: string;
  }
  - OptionaldrmProtection?: "Single Key" | "Multiple Keys"
    The DRM protection type to set (display label). If omitted then "None" will be chosen.
  - outputFormat: "HLS" | "DASH" | "DASH & HLS" | "CMAF" | "DASH On Demand" | "MPEG-2 TS"
    The output format to set (display label).
  - title: string
    A unique video processing profile title.
Returns Promise<void>

deleteVideo

deleteVideo(args: { title: string }): Promise<void>
This method deletes a video by title. The management system must be loaded & signed in before using this method. If a single matching, undeleted video is not found then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Videos' tile
- Filter by title and verify that a single result is shown
- Navigate to the video with the row action
- Click 'Delete' and confirm
- Wait for the videos explorer station to reload
Parameters
- args: { title: string }
  - title: string
    A unique video title.
Returns Promise<void>

deleteVideoProcessingProfile

deleteVideoProcessingProfile(args: { title: string }): Promise<void>
This method delete a video processing profile by title. The management system must be loaded & signed in before using this method. If a single matching processing profile is not found then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Settings' tile
- Navigate to the 'Video Encoding', 'Processing' tile
- Filter by title and select the processing profile row action
- Click the 'Delete' action and wait for the explorer station to load
Parameters
- args: { title: string }
  - title: string
    A unique video processing profile title.
Returns Promise<void>

navigateToVideoDetails

navigateToVideoDetails(args: { title: string }): Promise<void>
This method navigates to a video details station by title. The management system must be loaded & signed in before using this method. If there is not exactly one matching video an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb then the 'Videos' tile
- Filter by title and verify that a single result is shown
- Click the video row action
- Wait for the video details station to load
Parameters
- args: { title: string }
  - title: string
    A unique video title.
Returns Promise<void>

waitForEncodingSuccess

waitForEncodingSuccess(args: { videoSource: string }): Promise<void>
Parameters
- args: { videoSource: string }
Returns Promise<void>

Class VideoService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideoService

Properties

Protected Readonlypage

Protected ReadonlyuiManagedWorkflows

Protected ReadonlyuiShell

Methods

approveVideo

Parameters

title: string

Returns Promise<void>

archiveVideo

Parameters

title: string

Returns Promise<void>

createVideoProcessingProfile

Parameters

OptionaldrmProtection?: "Single Key" | "Multiple Keys"

outputFormat: "HLS" | "DASH" | "DASH & HLS" | "CMAF" | "DASH On Demand" | "MPEG-2 TS"

title: string

Returns Promise<void>

deleteVideo

Parameters

title: string

Returns Promise<void>

deleteVideoProcessingProfile

Parameters

title: string

Returns Promise<void>

navigateToVideoDetails

Parameters

title: string

Returns Promise<void>

waitForEncodingSuccess

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`page

`Protected` `Readonly`uiManagedWorkflows

`Protected` `Readonly`uiShell

`Optional`drmProtection?: "Single Key" | "Multiple Keys"