API Reference

Hosted Slicers

Categories and Endpoints

CategoryDescription
Cloud Slicer Live ManagementManage your CSL slicers, including creating, retrieving, updating, restarting, and deleting them.
- Create CSL Slicer: POST /managed-slicer/slicers
- Delete CSL Slicer: DELETE /managed-slicer/slicers/{Slicer ID}
- Get All CSL Slicers: GET /managed-slicer/slicers
- Get CSL Slicer: GET /managed-slicer/slicers/{Slicer ID}
- Restart CSL Slicer: GET /managed-slicer/slicers/restart/{Slicer ID}
- Update CSL Slicer: PATCH /managed-slicer/slicers/{Slicer ID}
TasksRetrieve information about CSL slicer tasks and ingest point tasks to track provisioning progress.
- Get All CSL Slicer Tasks: GET /managed-slicer/slicers/tasks
- Get All Ingest Point Tasks: GET /managed-slicer/ingest-points/tasks
- Get CSL Slicer Task: GET /managed-slicer/slicers/tasks/{Task ID}
- Get Ingest Point Task: GET /managed-slicer/ingest-points/tasks/{Task ID}
Ingest PointsManage ingest points where encoders push video feeds for streaming.
- Create Ingest Point: POST /managed-slicer/slicers/ingest-points
- Delete Ingest Point: DELETE /managed-slicer/slicers/ingest-points/{Ingest Point ID}
- Get All Ingest Points: GET /managed-slicer/slicers/ingest-points
- Get Ingest Point: GET /managed-slicer/slicers/ingest-points/{Ingest Point ID}
- Update Ingest Point: PATCH /managed-slicer/slicers/ingest-points/{Ingest Point ID}
ReferenceRetrieve key data for setting up CSL slicers, including encoding profiles, supported protocols, available regions, and slicer versions.
- Get Encoding Profiles: GET /slicers/encoding-profiles
- Get CSL Slicer Protocols: GET /managed-slicer/slicers/protocols
- Get CSL Slicer Versions: GET /managed-slicer/slicers/version/{Region}
- Get CSL Regions: GET /managed-slicer/regions
MonitoringMonitor the connection between the encoder and CSL slicer.
- Get Link Health: GET /managed-slicer/slicer/monitor/{Slicer ID}

Workflow

Follow these steps to publish a stream using a CSL slicer:

  1. Determine Configuration: Identify the slicer version, protocol, and region where your CSL slicer will be created.
    - Use GET /managed-slicer/slicers/version/{Region} to retrieve available slicer versions.
    - Use GET /managed-slicer/slicers/protocols to retrieve supported protocols.
    - Use GET /managed-slicer/regions to retrieve available hosting regions.
  2. Create an Ingest Point: Use POST /managed-slicer/slicers/ingest-points to create an ingest point where your encoder will push video feeds.
  3. Create a CSL Slicer: Use POST /managed-slicer/slicers with the information from Step 1 and the ingest point from Step 2.
  4. Monitor Slicer Status: Use GET /managed-slicer/slicers/{Slicer ID} to check the slicer status. Wait until its status is RUNNING.
  5. Integrate with Streaming Workflow: Add the CSL slicer to a live channel, live event, or failover group.
  6. Push Video Feed: From your encoder, push a video feed to the ingest point created in Step 2.
  7. Start Streaming: Direct your player to the playback URL of your live channel or live event.

This structured workflow ensures an efficient setup and operation of CSL slicers for live streaming.