Lists all watermark profiles for an account.
/accounts/{account_identifier}/stream/watermarks
get
Stream Watermark Profile
stream-watermark-profile-list-watermark-profiles
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "The account identifier tag.",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"created": {
"description": "The date and a time a watermark profile was created.",
"example": "2014-01-02T02:20:00Z",
"format": "date-time",
"type": "string"
},
"downloadedFrom": {
"description": "The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.",
"example": "https://company.com/logo.png",
"type": "string"
},
"height": {
"description": "The height of the image in pixels.",
"type": "integer"
},
"name": {
"default": "",
"description": "A short description of the watermark profile.",
"example": "Marketing Videos",
"type": "string"
},
"opacity": {
"default": 1,
"description": "The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.",
"example": 0.75,
"maximum": 1,
"minimum": 0,
"type": "number"
},
"padding": {
"default": 0.05,
"description": "The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.",
"example": 0.1,
"maximum": 1,
"minimum": 0,
"type": "number"
},
"position": {
"default": "upperRight",
"description": "The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.",
"example": "center",
"type": "string"
},
"scale": {
"default": 0.15,
"description": "The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.",
"example": 0.1,
"maximum": 1,
"minimum": 0,
"type": "number"
},
"size": {
"description": "The size of the image in bytes.",
"example": 29472,
"type": "number"
},
"uid": {
"description": "The unique identifier for a watermark profile.",
"example": "ea95132c15732412d22c1476fa83f27a",
"maxLength": 32,
"type": "string"
},
"width": {
"description": "The width of the image in pixels.",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List watermark profiles response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "List watermark profiles response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]