get_live_output_profiles
List all live output profiles (encoding/destination presets for live schedules).
get_live_output_profiles
List all live output profiles (encoding/destination presets for live schedules).
List every live output profile on the deployment. An output profile is an encoding/destination
preset (codec, resolution, bit-rate) that a live schedule's external_output_profiles references.
Safety class: A · API type: admin · Min version: -
ConfinementRead-only; safe anywhere. Profiles are account-global, not folder-confined.
Signatures
def get_live_output_profiles(sdk):
"""Return the live output profiles list (or None)."""
return sdk.get_live_output_profiles()export async function getLiveOutputProfiles(sdk) {
return await sdk.getLiveOutputProfiles();
}Parameters
| Parameter (Python) | Parameter (JS) | Type | Required | Notes |
|---|---|---|---|---|
sdk | sdk | Nomad_SDK | yes | admin-apiType client |
Returns
list | None - list of output-profile objects; each has id, name, enabled, videoCodec, videoWidth/Height, bit-rate fields. None if the request fails.
Errors
- 401 unauthenticated
- InvalidAPITypeException if session is not admin
Notes
Real-world usage
- Maps to
GET /liveOutputProfile. Profiles are not content, so the contentsearchAPI cannot find them - list them here and match bynameto resolve anExternal Output Profilecolumn to a{id, description}ref on the target deployment (sheet GUIDs are source-specific). - Each profile exposes
id,name,enabled, and its encoding settings (videoCodec,videoWidth/videoHeight, bit-rate fields).
Requires an admin session (raises
InvalidAPITypeExceptionotherwise).
Real-world usage
- Maps to
GET /liveOutputProfile. Profiles are not content, so the contentsearchAPI cannot find them - list them here and match bynameto resolve anExternal Output Profilecolumn to a{id, description}ref on the target deployment (sheet GUIDs are source-specific). - Each profile exposes
id,name,enabled, and its encoding settings (videoCodec,videoWidth/videoHeight, bit-rate fields).
Requires an admin session (raises
InvalidAPITypeExceptionotherwise).
See also: Python ↔ JS naming map · Return shapes.
