Jump to

• Request
• Response

Retrieve one config element: SD.media-profile

get

https://cloud-native-SBC-IP/config/v1/sd/media-profile/{ElementKey}

Retrieve one config element: SD.media-profile

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: MediaProfile

Body ()

Root Schema : schema

Type: object

configure a media profile and apply it to a media type

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• as-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  SDP b=AS: value to use for this codec when transcoding
• average-rate-limit: integer (int64)
  Minimum Value: 0

  Maximum Value: 125000000

  average rate limit of rtp flow
• clock-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  clock-rate in sdp rtpmap attribute in Hz (e.g 8000 for narrowband codecs). If left unconfigured with value 0, default clock-rate for the codec will be used
• media-type: string
  media type used in sdp m lines (e.g. audio, video, data)
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the media profile (e.g. PCMU, G723, G729)
• parameters: string
  list of <name=value> pairs (e.g silenceSupperssion=0)
• payload-type: string
  rtp payload type used in sdp m lines
• police-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  rate used for ACME media policing
• req-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  amount of bandwidth required (kilobits)
• sdp-bandwidth: boolean
  Use 'AS' parameter in the SDP to derive 'req-bandwidth' and 'average-rate-limit'
• sdp-rate-limit-headroom: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  headroom for using SDP bandwidth as the average-rate-limit (percentage)
• standard-pkt-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 125000000

  standard packetiztion rate for profile
• subname: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  encoding subname used for codec variation
• transport: string
  transport protocol used in sdp rtpmap attribute (e.g. RTP/AVP)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the media profile (e.g. PCMU, G723, G729)",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "subname":{
            "description":"encoding subname used for codec variation",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "media-type":{
            "description":"media type used in sdp m lines (e.g. audio, video, data)",
            "type":"string"
        },
        "payload-type":{
            "description":"rtp payload type used in sdp m lines",
            "type":"string"
        },
        "transport":{
            "description":"transport protocol used in sdp rtpmap attribute (e.g. RTP/AVP)",
            "type":"string"
        },
        "clock-rate":{
            "description":"clock-rate in sdp rtpmap attribute in Hz (e.g 8000 for narrowband codecs). If left unconfigured with value 0, default clock-rate for the codec will be used",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "req-bandwidth":{
            "description":"amount of bandwidth required (kilobits)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "parameters":{
            "description":"list of <name=value> pairs (e.g silenceSupperssion=0)",
            "type":"string"
        },
        "average-rate-limit":{
            "description":"average rate limit of rtp flow",
            "format":"int64",
            "maximum":125000000,
            "minimum":0,
            "type":"integer"
        },
        "sdp-rate-limit-headroom":{
            "description":"headroom for using SDP bandwidth as the average-rate-limit (percentage)",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "sdp-bandwidth":{
            "description":"Use 'AS' parameter in the SDP to derive 'req-bandwidth' and 'average-rate-limit'",
            "type":"boolean"
        },
        "police-rate":{
            "description":"rate used for ACME media policing",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "standard-pkt-rate":{
            "description":"standard packetiztion rate for profile",
            "format":"int64",
            "maximum":125000000,
            "minimum":0,
            "type":"integer"
        },
        "as-bandwidth":{
            "description":"SDP b=AS: value to use for this codec when transcoding",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a media profile and apply it to a media type",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top