MediaHarbor API (2026.6.8)

Download OpenAPI specification:Download

Layout

レイアウト関連

レイアウトを作成

新規レイアウトIDを作成。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

name

required

string

レイアウト名

background_image

string

背景画像 Base64エンコードされたデータ形式（data:image/png;base64,... 形式）

grid

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string

背景画像（Base64エンコードされたデータ）

grid

required

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

required

Array of objects (elements)

Array

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

required

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

required

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

Request samples

Payload
cURL

Content type

application/json

{"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}

レイアウトを取得

指定のレイアウトIDのレイアウトを取得
指定が無い場合は全て取得

Authorizations:

api_key_adminapi_key_app

query Parameters

id	string <uuid> Example: id=123e4567-e89b-12d3-a456-426614174000 レイアウトID

Responses

Response Schema: application/json

Array

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string

背景画像（Base64エンコードされたデータ）

grid

required

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

required

Array of objects (elements)

Array

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

required

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

required

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/layout?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}
]

レイアウトを更新

指定のレイアウトIDのレイアウトを更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id

required

string <uuid>

レイアウトID

name

string

レイアウト名

background_image

string

背景画像 Base64エンコードされたデータ形式（data:image/png;base64,... 形式）

grid

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string

背景画像（Base64エンコードされたデータ）

grid

required

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

required

Array of objects (elements)

Array

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

required

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

required

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

Request samples

Payload
cURL

Content type

application/json

{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}

レイアウトを削除

指定のレイアウトIDのレイアウト情報を削除します

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id

required

string <uuid>

レイアウトID

Responses

Request samples

Payload
cURL

Content type

application/json

{"id": "123e4567-e89b-12d3-a456-426614174000"
}

レイアウト要素を追加

新規レイアウトIDを作成。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string or null <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ

Responses

Response Schema: application/json

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

Request samples

Payload
cURL

Content type

application/json

{"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"source_id": "123e4567-e89b-12d3-a456-426614174000",
"skin_id": "123e4567-e89b-12d3-a456-426614174000",
"left": 0,
"top": 0,
"width": 240,
"height": 135
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

レイアウト要素を更新

指定のレイアウトIDのレイアウトを更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id required	string <uuid> 要素ID
layout_id	string <uuid> レイアウトID
source_id	string <uuid> ソースID
skin_id	string <uuid> スキンID
left	integer <int32> 左上X座標
top	integer <int32> 左上Y座標
width	integer <int32> 幅
height	integer <int32> 高さ

Responses

Response Schema: application/json

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

Request samples

Payload
cURL

Content type

application/json

{"id": "123e4567-e89b-12d3-a456-426614174000",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"source_id": "123e4567-e89b-12d3-a456-426614174000",
"skin_id": "123e4567-e89b-12d3-a456-426614174000",
"left": 0,
"top": 0,
"width": 480,
"height": 270
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

レイアウト要素を削除

指定のレイアウトIDのレイアウト情報を削除します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

要素ID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/layout/element?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

レイアウト要素を全削除

指定のレイアウトIDのレイアウト情報を全削除します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

レイアウトID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/layout/clear?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

レイアウト情報を再送・再起動

レイアウト情報を再送・再起動します。全スクリーンのレイアウトを更新し、レシーバーコンテナを再起動して、パトロールループとライセンスチェックを更新します。

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

clients

required

integer

接続クライアント数

statuuid

required

string <uuid>

ステータスUUID

required

object

HLSオーディオ位置情報

additional property

object

top	integer 上端位置
left	integer 左端位置
width	integer 幅
height	integer 高さ

required

Array of objects (screen)

スクリーン一覧

Array

id	integer スクリーンID
name	string スクリーン名
layout_id	string <uuid> レイアウトID
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID
audio_source_id	string <uuid> 音声選択されたソースID
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

required

Array of objects (layout)

レイアウト一覧

Array

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string

背景画像（Base64エンコードされたデータ）

grid

required

string

Enum: "2x2" "3x3" "4x4" "5x5" "6x6" "8x8" "10x10" "none"

グリッド設定

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

required

Array of objects (elements)

Array

id required	string <uuid> 要素ID
layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

required

Array of objects (syncGroup)

同期グループ

Array

id required	string <uuid> 同期再生グループID
name required	string 同期再生グループの名前
master_source_id required	string グループのマスターにするソースID
elements_source_id	Array of strings <uuid> [ items <uuid > ] グループに含まれるソースIDの一覧

required

object (sourceNameText)

ソース名表示設定

is_show_source_name required	boolean ソース名表示設定有効
x_align required	integer Enum: 0 1 2 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align required	integer Enum: 0 1 2 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color required	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size required	integer フォントサイズ

object or null (gridMargin)

グリッドマージン

top required	integer >= 0 上マージン[px]
right required	integer >= 0 右マージン[px]
bottom required	integer >= 0 下マージン[px]
left required	integer >= 0 左マージン[px]
rows	integer [ 1 .. 2 ] マージン適用行数

required

Array of objects (Source)

ソース一覧

Array

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

object

パラメータ

object

isIpv6	boolean IPv6アドレスを使用するか
mode	string Enum: "Listener" "Caller" モード
port	integer 内部接続用ポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

required

Array of resourceTypeText (object) or resourceTypePicture (object) or resourceTypeAnalogClock (object) or resourceTypeDigitalClock (object)

リソース一覧

Array

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align	integer 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size	integer フォントサイズ
is_vertical_text	boolean 縦書き表示するか

required

Array of objects (skin)

スキン一覧

Array

id

string <uuid>

スキンID

name

string

スキン名

Array of objects

要素

Array

type required	string Enum: "video" "audiobar" "text" "name" パーツタイプ
value	string type = audiobar : スピーカーIndex番号、 type = text : 表示文字列
left required	integer <int32> 左上X座標(%)
top required	integer <int32> 左上Y座標(%)
width required	integer <int32> 幅(%)
height required	integer <int32> 高さ(%)

isEnoughPatrolPoints

required

boolean

パトロールポイントが十分かどうか

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/layout/reload' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"clients": 5,
"statuuid": "123e4567-e89b-12d3-a456-426614174000",
"selectHLSAudioPosition": {"property1": {"top": 0,
"left": 0,
"width": 1920,
"height": 1080
},
"property2": {"top": 0,
"left": 0,
"width": 1920,
"height": 1080
}
},
"screens": [{"id": 1,
"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1,
"audio_source_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z"
}
],
"layouts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"grid": "2x2",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"sync_groups": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sync Group 1",
"master_source_id": "123e4567-e89b-12d3-a456-426614174000",
"elements_source_id": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"source_name_text": {"is_show_source_name": true,
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
},
"grid_margin": {"top": 0,
"right": 0,
"bottom": 0,
"left": 0,
"rows": 1
}
}
],
"sources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Source Name",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"isIpv6": false,
"mode": "Listener",
"port": 30000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"probesize": 100,
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}
],
"resources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40,
"is_vertical_text": false
}
}
],
"skins": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"elements": [{"type": "video",
"value": "string",
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
]
}
],
"isEnoughPatrolPoints": true
}

Source

入力ソース関連

入力ソースを新規登録

新しいソースを追加します。ソースIDは新しいUUIDを割り当て、返答に含めます。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

deehiveKey

string

ユニットID

name

required

string

ソース名

protocol_type_id

required

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

1

object

パラメータ

sourceProtocolSRTPropertyListener (object) or sourceProtocolSRTPropertyCaller (object)

One of

isIpv6	boolean IPv6アドレスを使用するか
port	integer 内部接続用ポート
receiver required	integer or null 受信コンテナ側ポート
mode required	string Value: "Listener" モード

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Responses

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

object

パラメータ

object

isIpv6	boolean IPv6アドレスを使用するか
mode	string Enum: "Listener" "Caller" モード
port	integer 内部接続用ポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Request samples

Payload
cURL

Content type

application/json

Example

1

{"deehiveKey": "AAA0000-000",
"name": "string",
"protocol_type_id": "1",
"parameter": {"connection": {"isIpv6": false,
"port": 30000,
"receiver": 51000,
"mode": "Listener"
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100,
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Source Name",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"isIpv6": false,
"mode": "Listener",
"port": 30000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"probesize": 100,
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

入力ソース情報を取得

入力ソースの情報を返します
ソースID指定無しの場合は全ての一覧を返します

Authorizations:

api_key_adminapi_key_app

query Parameters

id	string <uuid> ソースID

Responses

Response Schema: application/json

Array

id

string <uuid>

ソースID

deehiveKey

string

ユニットID

name

required

string

ソース名

protocol_type_id

required

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

1

object

パラメータ

sourceProtocolSRTPropertyListener (object) or sourceProtocolSRTPropertyCaller (object)

One of

isIpv6	boolean IPv6アドレスを使用するか
port	integer 内部接続用ポート
receiver required	integer or null 受信コンテナ側ポート
mode required	string Value: "Listener" モード

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/source?id=%7Bid%7D' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": "123e4567-e89b-12d3-a456-426614174000",
"deehiveKey": "AAA0000-000",
"name": "string",
"protocol_type_id": 1,
"parameter": {"connection": {"isIpv6": false,
"port": 30000,
"receiver": 51000,
"mode": "Listener"
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100,
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}
]

入力ソース情報を更新

指定のソースIDのソース情報を更新します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

ソースID

Request Body schema: application/json

deehiveKey

string

ユニットID

name

required

string

ソース名

protocol_type_id

required

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

1

object

パラメータ

sourceProtocolSRTPropertyListener (object) or sourceProtocolSRTPropertyCaller (object)

One of

isIpv6	boolean IPv6アドレスを使用するか
port	integer 内部接続用ポート
receiver required	integer or null 受信コンテナ側ポート
mode required	string Value: "Listener" モード

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Responses

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

object

パラメータ

object

isIpv6	boolean IPv6アドレスを使用するか
mode	string Enum: "Listener" "Caller" モード
port	integer 内部接続用ポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Request samples

Payload
cURL

Content type

application/json

Example

1

{"deehiveKey": "AAA0000-000",
"name": "string",
"protocol_type_id": "1",
"parameter": {"connection": {"isIpv6": false,
"port": 30000,
"receiver": 51000,
"mode": "Listener"
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100,
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Source Name",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"isIpv6": false,
"mode": "Listener",
"port": 30000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"probesize": 100,
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

入力ソース情報を削除

指定のソースIDのソース情報を削除します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

ソースID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/source?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

ソースをインポート

既存のソースデータをインポートします。既存のIDが指定された場合は更新、新規の場合は作成を行います。 UUID形式でないIDが指定された場合は新しいUUIDを生成します。ポート番号の重複チェックを行い、必要に応じて自動割り当てします。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

deehiveKey

string

ユニットID

name

required

string

ソース名

protocol_type_id

required

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

1

object

パラメータ

sourceProtocolSRTPropertyListener (object) or sourceProtocolSRTPropertyCaller (object)

One of

isIpv6	boolean IPv6アドレスを使用するか
port	integer 内部接続用ポート
receiver required	integer or null 受信コンテナ側ポート
mode required	string Value: "Listener" モード

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Responses

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

object

パラメータ

object

isIpv6	boolean IPv6アドレスを使用するか
mode	string Enum: "Listener" "Caller" モード
port	integer 内部接続用ポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID

1=srt
2=file
3=rtp
4=hls
5=streamlink
6=colorbar
7=browser
8=zixi
9=rist
10=ndi
11=st2110
12=rtmp
13=aes67
14=jpegxs
15=mhb
16=patrol

object

パラメータ

object

isIpv6	boolean IPv6アドレスを使用するか
mode	string Enum: "Listener" "Caller" モード
port	integer 内部接続用ポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sendbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) 0の場合は無制限
cryptomode	integer 暗号化 0 = none 1 = aes-128 2 = aes-256
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

deinterlace

boolean

デインターレース

object

リスケール

enable	boolean リスケール有効
width	integer リスケール幅[px]
height	integer リスケール高さ[px]

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

program_id

integer

サービスID指定

object (vamon)

画音監視設定

enable

boolean

画音監視有効

object

enable	boolean
threshold	integer ブラックアウト判定閾値
area	number <float> ブラックアウト判定領域[%]
duration	integer ブラックアウト判定時間[s]

object

enable	boolean
threshold	integer フリーズ判定閾値
area	number <float> フリーズ判定領域[%]
duration	integer フリーズ判定時間[s]

object

enable	boolean
threshold	integer 無音判定閾値
duration	integer 無音判定時間[s]

scte35

boolean

SCTE35解析

object (tsmon)

TS監視設定

enable

boolean

TS監視有効

ts_sync_loss

boolean

[ETR290 1.1] TS同期はずれ

sync_byte_error

boolean

[ETR290 1.2] 同期バイトエラー

pat_error

boolean

[ETR290 1.3] PATエラー

object

[ETR290 1.4] 連続カウントエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 1.5] PMTエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

pid_error

boolean

[ETR290 1.6] PIDエラー

Array of objects

[ETR290 1.6] PIDエラーでエラーとなるPIDリスト

Array

pid	integer PID
period	integer チェック間隔

transport_error

boolean

[ETR290 2.1] トランスポートエラー

object

[ETR290 2.2] CRCエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.3] PCRエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.4] PCRアキュラシエラーのビットレート

numerator	integer 分子
denominator	integer 分母

object

[ETR290 2.5] PTSエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object

[ETR290 2.6] CATエラー

enable	boolean 有効/無効
mask	Array of integers 除外するPIDリスト

object (startupWebhook)

受信開始時Webhook設定

enabled

boolean

起動時Webhook有効

method

string

Enum: "GET" "POST" "PUT" "DELETE"

メソッド

url

string

URL

Array of objects

ヘッダー

Array

key	string キー名
value	string 値

body

string

ボディ

afterWait

integer

Webhook送信後待機時間

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitrate	string

mask_rule_id

integer or null

マスクルールID

always_start

boolean

常に受信

tally_id

integer

タリーID

enableLowBandwidthError

boolean

低帯域幅エラー有効

lowBandwidthErrorThreshold

integer

低帯域幅エラー閾値

initialLogMaskSec

integer or null [ 0 .. 60 ]

起動時ログマスク時間(秒)

patrolSwitchLogMaskSec

integer or null [ 0 .. 60 ]

巡回切替時ログマスク時間(秒)

Response Schema: application/json

message

string

エラーメッセージ

Response Schema: application/json

error	string エラーメッセージ
details	string 詳細エラー情報
duplicateId	string <uuid> 重複したID
sqlMessage	string SQLエラーメッセージ

Request samples

Payload
cURL

Content type

application/json

Example

1

{"deehiveKey": "AAA0000-000",
"name": "string",
"protocol_type_id": "1",
"parameter": {"connection": {"isIpv6": false,
"port": 30000,
"receiver": 51000,
"mode": "Listener"
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100,
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

Response samples

200
201
400
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Source Name",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"isIpv6": false,
"mode": "Listener",
"port": 30000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sendbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"deinterlace": false,
"rescale": {"enable": false,
"width": 1280,
"height": 720
},
"probesize": 100,
"program_id": 1,
"vamon": {"enable": false,
"blackout": {"enable": true,
"threshold": 30,
"area": 100,
"duration": 10
},
"freeze": {"enable": true,
"threshold": 12,
"area": 99.9,
"duration": 90
},
"silence": {"enable": true,
"threshold": -48,
"duration": 45
}
},
"scte35": true,
"tsmon": {"enable": true,
"ts_sync_loss": true,
"sync_byte_error": true,
"pat_error": true,
"continuity_count_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pmt_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pid_error": true,
"pid_list": [{"pid": 0,
"period": 1
}
],
"transport_error": true,
"crc_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error": {"enable": true,
"mask": [0,
1,
2
]
},
"pcr_accuracy_error_bitrate": {"numerator": 10,
"denominator": 1
},
"pts_error": {"enable": true,
"mask": [0,
1,
2
]
},
"cat_error": {"enable": true,
"mask": [0,
1,
2
]
}
},
"startupWebhook": {"enabled": false,
"method": "POST",
"url": "https://example.com/webhook",
"headers": [{"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\"message\": \"Hello, world!\"}",
"afterWait": 3
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitrate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitrate": "1K"
}
},
"mask_rule_id": 1,
"always_start": false,
"tally_id": 1,
"enableLowBandwidthError": false,
"lowBandwidthErrorThreshold": 1000,
"initialLogMaskSec": 5,
"patrolSwitchLogMaskSec": 5
}

ソースのストリーム情報を取得

指定されたソースIDのストリーム情報を取得します。ストリームの詳細情報（解像度、フレームレート、コーデック等）を返します。

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

ソースID

Responses

Response Schema: application/json

width	integer 解像度の幅
height	integer 解像度の高さ
framerate	number フレームレート
codec	string コーデック名
bitrate	integer ビットレート
duration	number ストリームの長さ（秒）
status	string Enum: "active" "inactive" "error" ストリームの状態

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/source/streaminfo?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"width": 1920,
"height": 1080,
"framerate": 29.97,
"codec": "h264",
"bitrate": 5000000,
"duration": 3600.5,
"status": "active"
}

ソースのストリーム情報取得を要求

指定されたソースIDのストリーム情報取得を要求します。ストリーム情報の更新をトリガーします。

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

ソースID

Responses

Response Schema: application/json

success	boolean 要求の成功/失敗
message	string 結果メッセージ
sourceId	string <uuid> 対象ソースID

Request samples

cURL

curl -X 'POST' \
  'http://<ServerAddress>/api/source/streaminfo?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"success": true,
"message": "ストリーム情報取得要求を送信しました",
"sourceId": "123e4567-e89b-12d3-a456-426614174000"
}

NDIソース一覧を取得

ネットワーク上で利用可能なNDIソースの一覧を取得します。 NDI（Network Device Interface）対応デバイスから送信されているストリームの一覧を返します。

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

name	string NDIソース名
sourceName	string NDIソースの内部名
ipAddress	string <ipv4> 送信元IPアドレス
port	integer 送信元ポート番号
groupName	string NDIグループ名
urlAddress	string NDIソースのURLアドレス
isOnline	boolean オンライン状態
resolution	string 解像度
framerate	number フレームレート
colorFormat	string カラーフォーマット
audioChannels	integer オーディオチャンネル数
audioSampleRate	integer オーディオサンプルレート
audioBitsPerSample	integer オーディオビット深度

Response Schema: application/json

error

string

エラーメッセージ

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/source/ndi' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200
500

Content type

application/json

[{"name": "Camera 1",
"sourceName": "CAMERA_01",
"ipAddress": "192.168.1.100",
"port": 5353,
"groupName": "Production",
"urlAddress": "192.168.1.100:5353",
"isOnline": true,
"resolution": "1920x1080",
"framerate": 29.97,
"colorFormat": "UYVY",
"audioChannels": 2,
"audioSampleRate": 48000,
"audioBitsPerSample": 16
}
]

Resource

リソース関連

リソースを新規登録

新しいリソースを追加します。リソースIDは新しいUUIDを割り当て、返答に含めます。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

One of

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align	integer 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size	integer フォントサイズ
is_vertical_text	boolean 縦書き表示するか

Responses

Response Schema: application/json

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align	integer 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size	integer フォントサイズ
is_vertical_text	boolean 縦書き表示するか

Request samples

Payload
cURL

Content type

application/json

Example

resourceTypeText

{"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40,
"is_vertical_text": false
}
}

Response samples

200

Content type

application/json

Example

resourceTypeText

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40,
"is_vertical_text": false
}
}

リソース情報を取得

リソースの情報を返しますソースID指定無しの場合は全ての一覧を返します

Authorizations:

api_key_adminapi_key_app

query Parameters

id	string <uuid> リソースID

Responses

Response Schema: application/json

Array

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
data required	string 画像ファイルデータ（Base64エンコードされたデータ）

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/resource?id=%7Bid%7D' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "ロゴ画像",
"parameter": {"id": 1,
"type": "picture",
"data": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}
]

リソース情報を更新

指定のリソースIDのリソース情報を更新します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

リソースID

Request Body schema: application/json

One of

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align	integer 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size	integer フォントサイズ
is_vertical_text	boolean 縦書き表示するか

Responses

Response Schema: application/json

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

required

object

id required	integer リソースタイプID
type required	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 0 = 中央寄せ 1 = 左寄せ 2 = 右寄せ
y_align	integer 縦方向の配置 0 = 中央寄せ 1 = 上寄せ 2 = 下寄せ
text_color	string テキストの色 (未指定時のデフォルト色は白)
text_border_color	string テキストの枠線の色 (未指定時のデフォルト色はテキストの色と同じ)
text_background_color	string テキストの背景色 (未指定時のデフォルト色は透明)
font_size	integer フォントサイズ
is_vertical_text	boolean 縦書き表示するか

Request samples

Payload
cURL

Content type

application/json

Example

resourceTypeText

{"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40,
"is_vertical_text": false
}
}

Response samples

200

Content type

application/json

Example

resourceTypeText

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40,
"is_vertical_text": false
}
}

リソース情報を削除

指定のリソースIDのリソース情報を削除します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <uuid>

Example: id=123e4567-e89b-12d3-a456-426614174000

リソースID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/resource?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

Screen

スクリーン関連

スクリーンを作成

新規スクリーンを作成します。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

name required	string スクリーン名
layout_id	string <uuid> レイアウトID（空文字列の場合はレイアウトなし）
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID（指定しない場合は0）

Responses

Response Schema: application/json

id	integer スクリーンID
name	string スクリーン名
layout_id	string <uuid> レイアウトID
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID
audio_source_id	string <uuid> 音声選択されたソースID
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

Response Schema: application/json

error

string

エラーメッセージ

Request samples

Payload
cURL

Content type

application/json

{"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1
}

Response samples

200
400

Content type

application/json

{"id": 1,
"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1,
"audio_source_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z"
}

スクリーンを取得

指定のスクリーンIDのスクリーンを取得指定が無い場合は全て取得

Authorizations:

api_key_adminapi_key_app

query Parameters

id	integer Example: id=1 スクリーンID

Responses

Response Schema: application/json

Array

id	integer スクリーンID
name	string スクリーン名
layout_id	string <uuid> レイアウトID
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID
audio_source_id	string <uuid> 音声選択されたソースID
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

Response Schema: application/json

error

string

エラーメッセージ

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/screens?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200
400

Content type

application/json

[{"id": 1,
"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1,
"audio_source_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z"
}
]

スクリーンを更新

指定のスクリーンIDのスクリーンを更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id required	integer スクリーンID
name	string スクリーン名
layout_id	string <uuid> レイアウトID（空文字列の場合はレイアウトなし）
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID

Responses

Response Schema: application/json

id	integer スクリーンID
name	string スクリーン名
layout_id	string <uuid> レイアウトID
webrtc_bitrate	number WebRTCビットレート
custom_bitrate	number カスタム出力の最大ビットレート
display_output_enable	boolean ディスプレイ出力有効
display_output_connector_id	number ディスプレイ出力コネクタID
audio_source_id	string <uuid> 音声選択されたソースID
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

Response Schema: application/json

error

string

エラーメッセージ

Request samples

Payload
cURL

Content type

application/json

{"id": 1,
"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1
}

Response samples

200
400

Content type

application/json

{"id": 1,
"name": "Screen1",
"layout_id": "123e4567-e89b-12d3-a456-426614174000",
"webrtc_bitrate": 1000000,
"custom_bitrate": 2000000,
"display_output_enable": true,
"display_output_connector_id": 1,
"audio_source_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-10-01T12:00:00Z",
"updatedAt": "2023-10-01T12:00:00Z"
}

スクリーンを削除

指定のスクリーンIDのスクリーン情報を削除します

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

integer

Example: id=1

スクリーンID

Responses

Response Schema: application/json

error

string

エラーメッセージ

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/screens?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

400

Content type

application/json

{"error": "The maximum number of active layouts has been reached"
}

Config

設定関連

設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

required

object

http_iface	string 合成部のHTTPポート
http_port	integer <int32> 合成部のHTTPポート
mhbs_server_address	string MultiviewerサーバーのHTTPアドレス
mhb_api_address	string MediaHarborAPIサーバーのHTTPアドレス
media_dir	string ファイルソースの場所
media_json	string ソース設定jsonの場所
layout_json	string レイアウト設定jsonの場所

required

object

width	integer <int32> 幅
height	integer <int32> 高さ
scaling_algorithm	string スケーリングアルゴリズム

required

object

SRT出力設定

enable

boolean

出力有効

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

required

object

SRT出力設定

enable

boolean

出力有効

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

required

object

外部表示出力設定

enable	boolean 出力有効
connector_id	integer 出力先コネクタID

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/config' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"global": {"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
},
"render": {"width": 1920,
"height": 1080,
"scaling_algorithm": "bicubic"
},
"srt": {"enable": true,
"video": {"encoder": {"name": "openh264",
"options": ["string"
]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
},
"webrtc": {"enable": true,
"video": {"encoder": {"name": "openh264",
"options": ["string"
]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
},
"displayout": {"enable": true,
"connector_id": 0
}
}

一般設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

http_iface required	string 合成部のHTTPポート
http_port required	integer <int32> 合成部のHTTPアドレス
mhbs_server_address required	string MultiviewerサーバーのHTTPアドレス
mhb_api_address required	string MediaHarborAPIサーバーのHTTPアドレス
media_dir required	string ファイルソースの場所
media_json required	string ソース設定jsonの場所
layout_json required	string レイアウト設定jsonの場所

Responses

Response Schema: application/json

http_iface required	string 合成部のHTTPポート
http_port required	integer <int32> 合成部のHTTPアドレス
mhbs_server_address required	string MultiviewerサーバーのHTTPアドレス
mhb_api_address required	string MediaHarborAPIサーバーのHTTPアドレス
media_dir required	string ファイルソースの場所
media_json required	string ソース設定jsonの場所
layout_json required	string レイアウト設定jsonの場所

Request samples

Payload
cURL

Content type

application/json

{"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
}

Response samples

200

Content type

application/json

{"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
}

レンダー設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

width required	integer 幅
height required	integer 高さ
scaling_algorithm	string スケーリングアルゴリズム

Responses

Response Schema: application/json

width required	integer 幅
height required	integer 高さ
scaling_algorithm	string スケーリングアルゴリズム

Request samples

Payload
cURL

Content type

application/json

{"width": 1920,
"height": 1080,
"scaling_algorithm": "bicubic"
}

Response samples

200

Content type

application/json

{"width": 1920,
"height": 1080,
"scaling_algorithm": "bicubic"
}

SRT設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

Responses

Response Schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

Request samples

Payload
cURL

Content type

application/json

{"enable": true,
"video": {"encoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

Response samples

200

Content type

application/json

{"enable": true,
"video": {"encoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

WebRTC設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

Responses

Response Schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of strings エンコーダー設定

width

integer <int32>

出力動画の幅

height

integer <int32>

出力動画の高さ

bitrate

integer <int64>

出力動画のビットレート (byte単位)

Request samples

Payload
cURL

Content type

application/json

{"enable": true,
"video": {"encoder": {"name": "openh264",
"options": ["string"
]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

Response samples

200

Content type

application/json

{"enable": true,
"video": {"encoder": {"name": "openh264",
"options": ["string"
]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

HDMI出力設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

enable required	boolean 出力有効
connector_id required	integer コネクタID

Responses

Response Schema: application/json

enable required	boolean 出力有効
connector_id required	integer コネクタID

Request samples

Payload
cURL

Content type

application/json

{"enable": false,
"connector_id": 0
}

Response samples

200

Content type

application/json

{"enable": false,
"connector_id": 0
}

監視ログ設定を更新

監視ログ設定を更新する。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Responses

Response Schema: application/json

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ(日本語)

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Request samples

Payload
cURL

Content type

application/json

{"id": "00200201",
"level": 6,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}

Response samples

200

Content type

application/json

{"id": "00200201",
"type": "SYS",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}

監視ログ設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ(日本語)

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/config/monlog' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": "00200201",
"type": "SYS",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}
]

監視ログレベル設定を更新

監視ログレベル設定を更新する。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

level

required

integer

監視ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Responses

Response Schema: application/json

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Request samples

Payload
cURL

Content type

application/json

{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}

Response samples

200

Content type

application/json

{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}

監視ログレベル設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/config/monlog/level' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]

ログ保存期間を取得

指定されたテーブル名のログ保存期間を取得します。

Authorizations:

api_key_adminapi_key_app

query Parameters

table_name

required

string

Example: table_name=monlogs

テーブル名

Responses

Response Schema: application/json

retention_days	integer 保存期間（日数）
table_name	string Enum: "monlogs" "tsmon_data" テーブル名

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/config/monlog/retention?table_name=monlogs' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"retention_days": 30,
"table_name": "monlogs"
}

ログ保存期間を設定

指定されたテーブル名のログ保存期間を設定します。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

table_name required	string Enum: "monlogs" "tsmon_data" テーブル名
retention_days required	integer [ 1 .. 3650 ] 保存期間（日数）

Responses

Response Schema: application/json

retention_days	integer 保存期間（日数）
table_name	string Enum: "monlogs" "tsmon_data" テーブル名

Request samples

Payload
cURL

Content type

application/json

{"table_name": "monlogs",
"retention_days": 30
}

Response samples

200

Content type

application/json

{"retention_days": 30,
"table_name": "monlogs"
}

NICの一覧を取得

有効なネットワークインターフェースの一覧を取得します。
注意: このAPIを正しく動作させるためには、APIコンテナをnetwork_mode: hostで動作させる必要があります。

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

string

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/config/network_interfaces' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

["lo",
"eth0",
"eth1"
]

NDI Discovery Server設定を取得

現在のNDI Discovery Server設定を取得します

Authorizations:

api_key_admin

Responses

Response Schema: application/json

required

object

required

object

ips required	string IPアドレス設定
discovery required	string Discovery Server設定

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/ndiconf' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"ndi": {"networks": {"ips": "",
"discovery": "239.255.250.250:25000"
}
}
}

NDI Discovery Server設定を保存

NDI Discovery Server設定を保存し、ndifindプロセスを再起動します

Authorizations:

api_key_admin

Request Body schema: application/json

enabled required	boolean NDI Discovery Server有効フラグ
discovery required	string Discovery Server設定（IP:ポート形式）

Responses

Response Schema: application/json

success

required

boolean

設定保存成功フラグ

Request samples

Payload
cURL

Content type

application/json

{"enabled": true,
"discovery": "239.255.250.250:25000"
}

Response samples

200

Content type

application/json

{"success": true
}

Output

出力設定関連

出力設定一覧を取得

出力設定の一覧を取得します（システム出力設定を除く）

Authorizations:

api_key_admin

Responses

Response Schema: application/json

Array

id

integer

出力設定ID

name

required

string

出力設定名

enable

required

boolean

出力設定有効フラグ

source_type

required

string

Value: "screen"

出力元タイプ

screen: スクリーン

source_id

required

string

出力元ID(スクリーンID)

type

required

string

出力プロトコルタイプ

udp

required

object

パラメータ

isIpv6 required	boolean IPv6アドレスを使用するか
host required	string 出力先ホスト
port required	integer 出力先ポート
mode required	string Enum: "unicast" "multicast" 通信方式 unicast: ユニキャスト multicast: マルチキャスト
multicastIface required	string マルチキャスト送出用ネットワークインターフェース名

is_system_output

boolean

システム出力設定フラグ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/output' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": 1,
"name": "UDP出力1",
"enable": true,
"source_type": "screen",
"source_id": "1",
"type": "udp",
"params": {"isIpv6": false,
"host": "239.0.0.1",
"port": 5000,
"mode": "multicast",
"multicastIface": "eth1"
},
"is_system_output": false,
"createdAt": "2023-10-17T08:00:22.511511709Z",
"updatedAt": "2023-10-17T08:00:22.511511709Z"
}
]

出力設定を新規登録

新しい出力設定を追加します

Authorizations:

api_key_admin

Request Body schema: application/json

name

required

string

出力設定名

enable

required

boolean

出力設定有効フラグ

source_type

required

string

Value: "screen"

出力元タイプ

screen: スクリーン

source_id

required

string

出力元ID(スクリーンID)

type

required

string

出力プロトコルタイプ

udp

required

object

パラメータ

isIpv6 required	boolean IPv6アドレスを使用するか
host required	string 出力先ホスト
port required	integer 出力先ポート
mode required	string Enum: "unicast" "multicast" 通信方式 unicast: ユニキャスト multicast: マルチキャスト
multicastIface required	string マルチキャスト送出用ネットワークインターフェース名

Responses

Response Schema: application/json

id

integer

出力設定ID

name

required

string

出力設定名

enable

required

boolean

出力設定有効フラグ

source_type

required

string

Value: "screen"

出力元タイプ

screen: スクリーン

source_id

required

string

出力元ID(スクリーンID)

type

required

string

出力プロトコルタイプ

udp

required

object

パラメータ

isIpv6 required	boolean IPv6アドレスを使用するか
host required	string 出力先ホスト
port required	integer 出力先ポート
mode required	string Enum: "unicast" "multicast" 通信方式 unicast: ユニキャスト multicast: マルチキャスト
multicastIface required	string マルチキャスト送出用ネットワークインターフェース名

is_system_output

boolean

システム出力設定フラグ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

Request samples

Payload
cURL

Content type

application/json

Example

udp

{"name": "UDP出力1",
"enable": true,
"source_type": "screen",
"source_id": "1",
"type": "udp",
"params": {"isIpv6": false,
"host": "239.0.0.1",
"port": 5000,
"mode": "multicast",
"multicastIface": "eth1"
}
}

Response samples

200

Content type

application/json

Example

udp

{"id": 1,
"name": "UDP出力1",
"enable": true,
"source_type": "screen",
"source_id": "1",
"type": "udp",
"params": {"isIpv6": false,
"host": "239.0.0.1",
"port": 5000,
"mode": "multicast",
"multicastIface": "eth1"
},
"is_system_output": false,
"createdAt": "2023-10-17T08:00:22.511511709Z",
"updatedAt": "2023-10-17T08:00:22.511511709Z"
}

出力設定を更新

既存の出力設定を更新します

Authorizations:

api_key_admin

Request Body schema: application/json

name

required

string

出力設定名

enable

required

boolean

出力設定有効フラグ

source_type

required

string

Value: "screen"

出力元タイプ

screen: スクリーン

source_id

required

string

出力元ID(スクリーンID)

type

required

string

出力プロトコルタイプ

udp

required

object

パラメータ

isIpv6 required	boolean IPv6アドレスを使用するか
host required	string 出力先ホスト
port required	integer 出力先ポート
mode required	string Enum: "unicast" "multicast" 通信方式 unicast: ユニキャスト multicast: マルチキャスト
multicastIface required	string マルチキャスト送出用ネットワークインターフェース名

Responses

Response Schema: application/json

id

integer

出力設定ID

name

required

string

出力設定名

enable

required

boolean

出力設定有効フラグ

source_type

required

string

Value: "screen"

出力元タイプ

screen: スクリーン

source_id

required

string

出力元ID(スクリーンID)

type

required

string

出力プロトコルタイプ

udp

required

object

パラメータ

isIpv6 required	boolean IPv6アドレスを使用するか
host required	string 出力先ホスト
port required	integer 出力先ポート
mode required	string Enum: "unicast" "multicast" 通信方式 unicast: ユニキャスト multicast: マルチキャスト
multicastIface required	string マルチキャスト送出用ネットワークインターフェース名

is_system_output

boolean

システム出力設定フラグ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

Request samples

Payload
cURL

Content type

application/json

Example

udp

{"name": "UDP出力1",
"enable": true,
"source_type": "screen",
"source_id": "1",
"type": "udp",
"params": {"isIpv6": false,
"host": "239.0.0.1",
"port": 5000,
"mode": "multicast",
"multicastIface": "eth1"
}
}

Response samples

200

Content type

application/json

Example

udp

{"id": 1,
"name": "UDP出力1",
"enable": true,
"source_type": "screen",
"source_id": "1",
"type": "udp",
"params": {"isIpv6": false,
"host": "239.0.0.1",
"port": 5000,
"mode": "multicast",
"multicastIface": "eth1"
},
"is_system_output": false,
"createdAt": "2023-10-17T08:00:22.511511709Z",
"updatedAt": "2023-10-17T08:00:22.511511709Z"
}

出力設定を削除

指定した出力設定を削除します

Authorizations:

api_key_admin

query Parameters

id

required

integer

Example: id=1

出力設定ID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/output?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

Overlay

オーバーレイ関連

画音監視オーバーレイを初期化

画音監視オーバーレイを初期化します

Authorizations:

api_key_admin

Request Body schema: application/json

source_id

required

string <uuid>

ソースID

Responses

Request samples

Payload
cURL

Content type

application/json

{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

画音監視オーバーレイを表示

画音監視オーバーレイを表示します。マスク設定が有効な場合はマスク状態を返します

Authorizations:

api_key_admin

Request Body schema: application/json

source_id

required

string <uuid>

ソースID

Responses

Response Schema: application/json

One of

status

string

マスク状態

Request samples

Payload
cURL

Content type

application/json

{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

Response samples

200

Content type

application/json

{ }

入力ビットレート監視オーバーレイを表示

入力ビットレート監視オーバーレイを表示します。マスク設定が有効な場合はマスク状態を返します

Authorizations:

api_key_admin

Request Body schema: application/json

source_id

required

string <uuid>

ソースID

Responses

Response Schema: application/json

One of

status

string

マスク状態

Request samples

Payload
cURL

Content type

application/json

{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

Response samples

200

Content type

application/json

{ }

入力ビットレート監視オーバーレイを初期化

入力ビットレート監視オーバーレイを初期化します

Authorizations:

api_key_admin

Request Body schema: application/json

source_id

required

string <uuid>

ソースID

Responses

Request samples

Payload
cURL

Content type

application/json

{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

TS監視オーバーレイを表示

TS監視オーバーレイを表示します。マスク設定が有効な場合はマスク状態を返します

Authorizations:

api_key_admin

Request Body schema: application/json

Array

source_id

required

string <uuid>

ソースID

Responses

Response Schema: application/json

One of

status

string

マスク状態

Request samples

Payload
cURL

Content type

application/json

[{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}
]

Response samples

200

Content type

application/json

{ }

TS監視オーバーレイを初期化

TS監視オーバーレイを初期化します

Authorizations:

api_key_admin

Request Body schema: application/json

Array

source_id

required

string <uuid>

ソースID

Responses

Request samples

Payload
cURL

Content type

application/json

[{"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}
]

Secret

Deehive関連シークレット更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

auth_endpoint required	string deehive へのリクエストを認証するために使用するエンドポイント。
device_params_endpoint required	string デバイスのパラメータを更新するために使用されるエンドポイント（Deehiveビデオの解像度の変更など）
id required	string deehiveからのid
secret required	string deehiveからのsecret

Responses

Response Schema: application/json

auth_endpoint required	string deehive へのリクエストを認証するために使用するエンドポイント。
device_params_endpoint required	string デバイスのパラメータを更新するために使用されるエンドポイント（Deehiveビデオの解像度の変更など）
id required	string deehiveからのid
secret required	string deehiveからのsecret

Request samples

Payload
cURL

Content type

application/json

{"auth_endpoint": "<DeeHive_url>/api/v1/api/v1/authentication",
"device_params_endpoint": "<DeeHive_url>/api/v1/api/v1/device-params",
"id": "63eb3c972d17d200113d8765",
"secret": "secretkey12345"
}

Response samples

200

Content type

application/json

{"auth_endpoint": "<DeeHive_url>/api/v1/api/v1/authentication",
"device_params_endpoint": "<DeeHive_url>/api/v1/api/v1/device-params",
"id": "63eb3c972d17d200113d8765",
"secret": "secretkey12345"
}

License関連シークレット更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

api_key required	string LicenseManagerでMediaHarbor割り当てたapi_key
url required	string LicenseManagerのAPI

Responses

Response Schema: application/json

api_key required	string LicenseManagerでMediaHarbor割り当てたapi_key
url required	string LicenseManagerのAPI

Request samples

Payload
cURL

Content type

application/json

{"api_key": "31cf8386-9fca-48a1-9572-2ba60d70be8e",
"url": "https://license.trafficsim.co.jp"
}

Response samples

200

Content type

application/json

{"api_key": "31cf8386-9fca-48a1-9572-2ba60d70be8e",
"url": "https://license.trafficsim.co.jp"
}

Notification

通知関連

通知を取得

通知を取得します。

Authorizations:

api_key_adminapi_key_app

query Parameters

qty	integer Example: qty=100 取得件数 ※未指定時は100件
offset	integer 取得開始位置続きを取る時にオフセットを指定する。指定したオフセット値から取得される。 ※未指定時は0から取得

Responses

Response Schema: application/json

total

integer <int64>

通知件数

Array of objects

通知一覧

Array

id

required

integer

通知ID

required

object

ログ情報

id

integer <int64>

ID

date

string <date-time>

監視日時

source_id

string <uuid>

ソースID

log_id

string^[0-9a-fA-F]{8}$

ログID

object

ソース情報

name	string ソース名
protocol_type_id	integer プロトコルタイプID 1=srt 2=file 3=rtp 4=hls 5=streamlink 6=colorbar 7=browser 8=zixi 9=rist 10=ndi 11=st2110 12=rtmp 13=aes67 14=jpegxs 15=mhb 16=patrol

object

詳細情報

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

string

ログメッセージ

message_en

string

ログメッセージ(英語)

jsondata

string

JSONデータ

required

object (notificationRule)

通知ルール設定構造

id required	integer 通知先ID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先ID一覧
levels required	Array of integers ログレベル情報

required

object (notificationDestination)

通知先設定構造

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細設定（通知先タイプによって内容が異なります） Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) key: ヘッダーキー value: ヘッダー値 body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

scheduled_time

required

string

通知予定日時

is_success

required

boolean

通知成功フラグ

error_message

required

object

エラーメッセージ

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/notification?qty=100&offset=0' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"total": 0,
"histories": [{"id": 1,
"log": {"id": 0,
"date": "2019-08-24T14:15:22Z",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"log_id": "00200201",
"source": {"name": "string",
"protocol_type_id": 1
},
"details": {"type": "VA",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected"
},
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
},
"rule": {"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
},
"destination": {"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
},
"scheduled_time": "2021-01-01T00:00:00Z",
"is_success": true,
"error_message": {"message": "通知に失敗しました。"
}
}
]
}

通知先設定を新規登録

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

name required	string 通知先名
type required	integer Enum: 1 2 3 4 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細 Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細設定（通知先タイプによって内容が異なります） Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) key: ヘッダーキー value: ヘッダー値 body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

Request samples

Payload
cURL

Content type

application/json

{"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知先設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細設定（通知先タイプによって内容が異なります） Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) key: ヘッダーキー value: ヘッダー値 body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/notification/destination' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
]

通知先設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細設定（通知先タイプによって内容が異なります） Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) key: ヘッダーキー value: ヘッダー値 body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
tz required	string タイムゾーン
lang required	string 言語
detail required	object 通知先詳細設定（通知先タイプによって内容が異なります） Slack通知 (type: 1) の場合: url: Slack Webhook URL channel: 通知先チャンネル名 mention: メンション設定 ("none", "<!channel>", "<!here>", "<!everyone>") username: 表示ユーザー名 iconEmoji: アイコン絵文字 iconUrl: アイコン画像URL メール通知 (type: 2) の場合: smtpServer: SMTPサーバーホスト smtpPort: SMTPポート番号 smtpSecure: SMTPセキュリティタイプ 0 = NONE 1 = TLS 2 = STARTTLS smtpAuth: SMTP認証フラグ user: ユーザー名（メールアドレス） password: パスワード sender: 送信者メールアドレス to: 宛先メールアドレス subject: メール件名 Webhook通知 (type: 3) の場合: url: Webhook URL method: HTTPメソッド (GET/POST/PUT) headers: HTTPヘッダー配列 (オプション) key: ヘッダーキー value: ヘッダー値 body: メッセージ本文 (マクロ変数対応) SNMP Trap通知 (type: 4) の場合: host: SNMPホスト port: SNMPポート version: SNMPバージョン (v1/v2c/v3) charset: 文字エンコーディング (utf-8/shift_jis/euc-jp/iso-2022-jp) community: SNMPコミュニティ名 (v1, v2c用) message: Trapメッセージ (マクロ変数対応) user: ユーザー名 (v3用、オプション) securityLevel: セキュリティレベル (v3用、オプション) authProtocol: 認証プロトコル (v3用、オプション) authKey: 認証キー (v3用、オプション) privProtocol: 暗号化プロトコル (v3用、オプション) privKey: 暗号化キー (v3用、オプション) engineID: エンジンID (v3用、オプション)

Request samples

Payload
cURL

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知先設定を削除

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

integer

Example: id=1

通知先ID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/notification/destination?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

通知テストを送信

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

type required	integer Enum: 1 2 3 4 通知先タイプ 1: Slack通知 2: メール通知 3: Webhook通知 4: SNMP Trap通知
lang required	string 言語
tz	string タイムゾーン
detail required	object 通知先詳細

Responses

Request samples

Payload
cURL

Content type

application/json

{"type": 1,
"lang": "ja",
"tz": "Asia/Tokyo",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知ルール設定を新規登録

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先情報
levels required	Array of integers ログレベル情報

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先ID一覧
levels required	Array of integers ログレベル情報

Request samples

Payload
cURL

Content type

application/json

{"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
}

通知ルール設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

id required	integer 通知先ID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先ID一覧
levels required	Array of integers ログレベル情報

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/notification/rule' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
}
]

通知ルール設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id required	integer 通知ルールID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先情報
levels required	Array of integers ログレベル情報

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	object 時間マスク設定
destination_ids required	Array of integers 通知先ID一覧
levels required	Array of integers ログレベル情報

Request samples

Payload
cURL

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": true,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"destination_ids": [1,
2
],
"levels": [1,
2
]
}

通知ルール設定を削除

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

integer

Example: id=1

通知ルールID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/notification/rule?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

Mask

マスク関連

マスクルール設定を新規登録

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

name

required

string

マスクルール名

enable

required

boolean

マスクルール有効フラグ

object

ログマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string^([01]\d\|2[0-3]):([0-5]\d)$ 開始時間(HH:MM形式、24時間表記)
duration	integer >= 1 マスク時間(分)
dayOfWeek	Array of integers[ items [ 0 .. 6 ] ] 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

object

オーバーレイマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string^([01]\d\|2[0-3]):([0-5]\d)$ 開始時間(HH:MM形式、24時間表記)
duration	integer >= 1 マスク時間(分)
dayOfWeek	Array of integers[ items [ 0 .. 6 ] ] 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

object

蓋マスク設定

enable	boolean 有効/無効
img	string 画像
log	boolean ログの有効/無効
overlay	boolean オーバーレイの有効/無効
silent	boolean サイレントの有効/無効

Responses

Response Schema: application/json

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	object or null ログマスク設定
overlay required	object or null オーバーレイマスク設定
cover required	object or null 蓋マスク設定

Request samples

Payload
cURL

Content type

application/json

{"name": "マスクルール 1",
"enable": true,
"log": {"enable": false,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"overlay": true,
"silent": false
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": true,
"log": { },
"overlay": { },
"cover": { }
}

マスクルールを取得

マスクルール設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

id

required

integer

マスクルールID

name

required

string

マスクルール名

enable

required

boolean

マスクルール有効フラグ

object

ログマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string 開始時間(HH:MM)
duration	integer マスク時間(分)
dayOfWeek	Array of integers 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

unmaskOnRecovery

boolean

復旧時に自動でマスク解除するか

object

オーバーレイマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string 開始時間(HH:MM)
duration	integer マスク時間(分)
dayOfWeek	Array of integers 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

unmaskOnRecovery

boolean

復旧時に自動でマスク解除するか

object

蓋マスク設定

enable	boolean 有効/無効
img	string 画像
log	boolean ログマスク設定
overlay	boolean
silent	boolean

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/mask' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": false,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
],
"unmaskOnRecovery": false
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
],
"unmaskOnRecovery": false
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"overlay": true,
"silent": false
}
}
]

マスクルール設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

id

required

integer

マスクルールID

name

required

string

マスクルール名

enable

required

boolean

マスクルール有効フラグ

object

ログマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string 開始時間(HH:MM)
duration	integer マスク時間(分)
dayOfWeek	Array of integers 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

unmaskOnRecovery

boolean

復旧時に自動でマスク解除するか

object

オーバーレイマスク設定

enable

boolean

有効/無効

tz

string

タイムゾーン

Array of objects

時間マスク設定

Array

start	string 開始時間(HH:MM)
duration	integer マスク時間(分)
dayOfWeek	Array of integers 曜日(0:日曜日, 1:月曜日, 2:火曜日, 3:水曜日, 4:木曜日, 5:金曜日, 6:土曜日)

unmaskOnRecovery

boolean

復旧時に自動でマスク解除するか

object

蓋マスク設定

enable	boolean 有効/無効
img	string 画像
log	boolean ログマスク設定
overlay	boolean
silent	boolean

Responses

Response Schema: application/json

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	object or null ログマスク設定
overlay required	object or null オーバーレイマスク設定
cover required	object or null 蓋マスク設定

Request samples

Payload
cURL

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": false,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
],
"unmaskOnRecovery": false
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1
]
}
],
"unmaskOnRecovery": false
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"overlay": true,
"silent": false
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": true,
"log": { },
"overlay": { },
"cover": { }
}

マスクルール設定を削除

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

integer

Example: id=1

マスクルールID

Responses

Request samples

cURL

curl -X 'DELETE' \
  'http://<ServerAddress>/api/mask?id=1' \
  -H 'x-api-key: YOUR_API_KEY'

Security

セキュリティ関連

パスワード設定を登録

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

role required	string Enum: "admin" "app" パスワード設定の種類
password required	string [ 10 .. 64 ] characters ^[!-~]$ パスワード（以下の条件を満たす必要があります） 10文字以上64文字以下数字を含む大文字を含む小文字を含む記号を含む（!@#$%^&()_+-=[]{};':",./<>?）全角文字を含まない既存のパスワードと重複しない

Responses

Response Schema: application/json

error

string

エラーメッセージ

Request samples

Payload
cURL

Content type

application/json

{"role": "admin",
"password": "Password123$"
}

Response samples

400

Content type

application/json

{"error": "password already set"
}

セキュリティ設定を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

admin required	boolean 管理者パスワードが設定されているかどうか
app required	boolean アプリケーションパスワードが設定されているかどうか

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/security' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"admin": true,
"app": false
}

パスワード設定を更新

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

role required	string Enum: "admin" "app" パスワード設定の種類
beforePassword required	string [ 10 .. 64 ] characters ^[!-~]$ 変更前パスワード（以下の条件を満たす必要があります） 10文字以上64文字以下数字を含む大文字を含む小文字を含む記号を含む（!@#$%^&()_+-=[]{};':",./<>?）全角文字を含まない
password required	string [ 10 .. 64 ] characters ^[!-~]$ 新しいパスワード（以下の条件を満たす必要があります） 10文字以上64文字以下数字を含む大文字を含む小文字を含む記号を含む（!@#$%^&()_+-=[]{};':",./<>?）全角文字を含まない既存のパスワードと重複しない

Responses

Response Schema: application/json

error

string

エラーメッセージ

Response Schema: application/json

error

string

エラーメッセージ

Request samples

Payload
cURL

Content type

application/json

{"role": "admin",
"beforePassword": "Password1234$",
"password": "Password123$"
}

Response samples

400
404

Content type

application/json

{"error": "password already set"
}

パスワード設定を削除

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

role

required

string

Enum: "admin" "app"

パスワード設定の種類

Responses

Response Schema: application/json

error

string

エラーメッセージ

Response Schema: application/json

error

string

エラーメッセージ

Request samples

Payload
cURL

Content type

application/json

{"role": "admin"
}

Response samples

400
404

Content type

application/json

{"error": "password already set"
}

Auth

認証関連

セッションを検証

現在のセッションクッキー(session_id)が有効かどうかを検証します。対象ロールのパスワードロックが無効化されている場合はセッションが無効化され、Unauthorizedとなります。

Responses

Response Schema: application/json

role

required

string

Enum: "admin" "app"

セッションのロール

Request samples

cURL

curl -X 'POST' \
  'http://<ServerAddress>/api/auth/verify-session'

Response samples

200

Content type

application/json

{"role": "admin"
}

ログアウト

現在のセッションを破棄し、セッションクッキー(session_id)を削除します。

Responses

Request samples

cURL

curl -X 'POST' \
  'http://<ServerAddress>/api/auth/logout'

Other

その他

カーソル選択

選択したソースの音が出る

Authorizations:

api_key_app

Request Body schema: application/json

screen_id required	integer スクリーンID
source_id required	string <uuid> ソースID

Responses

Response Schema: application/json

screen_id	integer スクリーンID
source_id	string <uuid> ソースID

Request samples

Payload
cURL

Content type

application/json

{"screen_id": 1,
"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

Response samples

200

Content type

application/json

{"screen_id": 1,
"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

カーソル取得

選択されたソースを取得する

Authorizations:

api_key_app

Request Body schema: application/json

screen_id

required

integer

スクリーンID

Responses

Response Schema: application/json

screen_id	integer スクリーンID
source_id	string <uuid> ソースID

Request samples

Payload
cURL

Content type

application/json

{"screen_id": 1
}

Response samples

200

Content type

application/json

{"screen_id": 1,
"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

クリック位置による音声選択

クリック位置からレイアウト要素を特定して音声選択する

Authorizations:

api_key_app

Request Body schema: application/json

screen_id required	integer スクリーンID
left required	integer クリック位置のX座標
top required	integer クリック位置のY座標

Responses

Response Schema: application/json

screen_id	integer スクリーンID
source_id	string <uuid> 選択されたソースID

Request samples

Payload
cURL

Content type

application/json

{"screen_id": 1,
"left": 100,
"top": 200
}

Response samples

200

Content type

application/json

{"screen_id": 1,
"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1"
}

現在のズーム状態を取得

現在のズーム状態を取得する

Authorizations:

api_key_app

Responses

Response Schema: application/json

zoom	integer ズーム中のソースインデックス（-1でズーム解除状態）

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/zoom' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"zoom": 0
}

1画面拡大表示

指定したソースIDを拡大表示する。空を指定するとZoom解除

Authorizations:

api_key_app

Request Body schema: application/json

index

required

integer

拡大するソースのインデックス（-1でズーム解除）

Responses

Request samples

Payload
cURL

Content type

application/json

{"index": 0
}

残りポイント情報を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

Array

id	string <uuid> WalletID
casthive_id	string <uuid> 組織ID
available_dates	number <float> 利用可能日数
point	number <float> 残りポイント数
pointType	string Enum: "MHP" "MHTP" "MONP" "MONTP" ポイント種別

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/creditpoint' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"casthive_id": "434b9872-024a-4aab-a019-2ea4b02b26e8",
"available_dates": 3347.63,
"point": 40171.54,
"pointType": "MHP"
}
]

サーバーステータスを取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

platform	string <string> プラットフォーム名
cpuCount	integer <int32> CPUコア数
systemUptime	number <float> システム稼働時間
processUptime	number <float> プロセス稼働時間

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/status' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"platform": "linux",
"cpuCount": 8,
"systemUptime": 7253930.68,
"processUptime": 3110.161115491
}

CPUステータスを取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

cpuCount	integer CPUコア数
loadAvg	Array of numbers <float> [ items <float > ] CPU負荷率(1分/5分/15分平均)
cpuUsage	number <float> CPU使用率

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/status/cpu' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"cpuCount": 8,
"loadAvg": [5.03,
4.21,
3.87
],
"cpuUsage": 0.4098360655737705
}

メモリーステータスを取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

totalMemory	number <float> メモリー総容量
freeMemory	number <float> メモリー空き容量
freeMemoryPercentage	number <float> メモリー空き容量率

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/status/memory' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"totalMemory": 15603.640625,
"freeMemory": 11087.9453125,
"freeMemoryPercentage": 0.7105998900496979
}

ストレージステータスを取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/json

total	integer <int64> ストレージ総容量
free	integer <int64> ストレージ空き容量
used	integer <int64> ストレージ使用容量
usagePercent	number <float> ストレージ使用率

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/status/storage' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"total": 287886413824,
"free": 243327467520,
"used": 44558946304,
"usagePercent": 15.477960808265587
}

コンテナ情報を取得

Authorizations:

api_key_adminapi_key_app

Responses

Response Schema: application/x-ndjson

string

Newline Delimited JSON形式でコンテナ情報をストリーミング配信各行が1つのコンテナ情報のJSONオブジェクト

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/container' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/x-ndjson

"{\"Id\":\"fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35\",\"Created\":\"2023-10-17T08:00:22.511511709Z\",...}\n{\"Id\":\"abc123def456...\",\"Created\":\"2023-10-17T08:00:22.511511709Z\",...}\ntype: object\nproperties:\n  Id:\n    type: string\n    description: Dockerコンテナの一意の識別子。\n    example: \"fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35\"\n  Created:\n    type: string\n    format: date-time\n    description: Dockerコンテナが作成されたタイムスタンプ。\n    example: \"2023-10-17T08:00:22.511511709Z\"\n  Path:\n    type: string\n    description: エントリポイントスクリプトへのパス。\n    example: \"docker-entrypoint.sh\"\n  Args:\n    type: array\n    items:\n      type: string\n    description: エントリポイントスクリプトに渡された引数。\n    example: [\"mariadbd\"]\n  State:\n    type: object\n    description: Dockerコンテナの現在の状態。\n    properties:\n      Status:\n        type: string\n        description: コンテナの状態（例：running、pausedなど）。\n        example: \"running\"\n      Running:\n        type: boolean\n        description: コンテナが実行中であるかどうかを示します。\n        example: true\n      Paused:\n        type: boolean\n        description: コンテナが一時停止されているかどうかを示します。\n        example: false\n      Restarting:\n        type: boolean\n        description: コンテナが再起動中であるかどうかを示します。\n        example: false\n      OOMKilled:\n        type: boolean\n        description: コンテナがOOM（Out Of Memory）キルされたかどうかを示します。\n        example: false\n      Dead:\n        type: boolean\n        description: コンテナが死んでいるかどうかを示します。\n        example: false\n      Pid:\n        type: integer\n        description: コンテナのプロセスID。\n        example: 1496904\n      ExitCode:\n        type: integer\n        description: コンテナの終了コード。\n        example: 0\n      Error:\n        type: string\n        description: エラーメッセージ。\n        example: \"\"\n      StartedAt:\n        type: string\n        format: date-time\n        description: コンテナが開始されたタイムスタンプ。\n        example: \"2023-10-17T08:00:23.128832275Z\"\n      FinishedAt:\n        type: string\n        format: date-time\n        description: コンテナが終了したタイムスタンプ。\n        example: \"0001-01-01T00:00:00Z\"\n  Image:\n    type: string\n    description: DockerイメージのSHA256ハッシュ。\n    example: \"sha256:871a9153c1842e3b480cb1be691c64151bc96a5de2cc8039470d31e32ff0a177\"\n  ResolvConfPath:\n    type: string\n    description: resolv.confファイルへのパス。\n    example: \"/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/resolv.conf\"\n  HostnamePath:\n    type: string\n    description: hostnameファイルへのパス。\n    example: \"/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/hostname\"\n  HostsPath:\n    type: string\n    description: hostsファイルへのパス。\n    example: \"/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/hosts\"\n  LogPath:\n    type: string\n    description: ログファイルへのパス。\n    example: \"/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35-json.log\"\n  Name:\n    type: string\n    description: コンテナの名前。\n    example: \"/db\"\n  RestartCount:\n    type: integer\n    description: コンテナの再起動回数。\n    example: 0\n  Driver:\n    type: string\n    description: ストレージドライバーの種類。\n    example: \"overlay2\"\n  Platform:\n    type: string\n    description: プラットフォーム名。\n    example: \"linux\"\n  MountLabel:\n    type: string\n    description: マウントラベル。\n    example: \"\"\n  ProcessLabel:\n    type: string\n    description: プロセスラベル。\n    example: \"\"\n  AppArmorProfile:\n    type: string\n    description: AppArmorプロファイル。\n    example: \"\"\n  ExecIDs:\n    type: array\n    items:\n      type: string\n    description: 実行IDのリスト。\n    example: null\n  HostConfig:\n    type: object\n    description: ホストの設定。\n    properties:\n      Binds:\n        type: array\n        items:\n          type: string\n        description: このコンテナのボリュームバインディングのリスト。\n        example:\n          [\n            \"/var/samba/public/MediaHarborFrontend/DB/data:/var/lib/mysql:rw\",\n            \"/var/samba/public/MediaHarborFrontend/conf/DB/my.cnf:/etc/mysql/conf.d/my.cnf:rw\",\n          ]\n      ContainerIDFile:\n        type: string\n        description: コンテナIDを保存するファイルのパス。\n        example: \"\"\n      LogConfig:\n        type: object\n        description: ログの設定。\n        properties:\n          Type:\n            type: string\n            description: ログのタイプ。\n            example: \"json-file\"\n          Config:\n            type: object\n            description: ログ設定の構成。\n            properties:\n              max-file:\n                type: string\n                description: 最大ファイル数。\n                example: \"3\"\n              max-size:\n                type: string\n                description: 最大ファイルサイズ。\n                example: \"1M\"\n      NetworkMode:\n        type: string\n        description: ネットワークモード。\n        example: \"mediaharborfrontend_default\"\n      PortBindings:\n        type: object\n        description: ポートバインディングの設定。\n        properties:\n          \"3306/tcp\":\n            type: array\n            items:\n              type: object\n              properties:\n                HostIp:\n                  type: string\n                  description: ホストのIPアドレス。\n                  example: \"\"\n                HostPort:\n                  type: string\n                  description: ホストのポート番号。\n                  example: \"3306\"\n      RestartPolicy:\n        type: object\n        description: 再起動ポリシーの設定。\n        properties:\n          Name:\n            type: string\n            description: 再起動ポリシーの名前。\n            example: \"always\"\n          MaximumRetryCount:\n            type: integer\n            description: 最大リトライ回数。\n            example: 0\n      AutoRemove:\n        type: boolean\n        description: コンテナが停止したときに自動的に削除するかどうか。\n        example: false\n      VolumeDriver:\n        type: string\n        description: ボリュームドライバー。\n        example: \"\"\n      VolumesFrom:\n        type: array\n        items:\n          type: string\n        description: 他のコンテナからボリュームをマウントする設定。\n        example: null\n      ConsoleSize:\n        type: array\n        items:\n          type: integer\n        description: コンソールのサイズ設定。\n        example: [0, 0]\n      CapAdd:\n        type: array\n        items:\n          type: string\n        description: 追加するケーパビリティのリスト。\n        example: null\n      CapDrop:\n        type: array\n        items:\n          type: string\n        description: 削除するケーパビリティのリスト。\n        example: null\n      CgroupnsMode:\n        type: string\n        description: cgroup名前空間モード。\n        example: \"host\"\n      Dns:\n        type: array\n        items:\n          type: string\n        description: DNSサーバのリスト。\n        example: null\n      DnsOptions:\n        type: array\n        items:\n          type: string\n        description: DNSオプションのリスト。\n        example: null\n      DnsSearch:\n        type: array\n        items:\n          type: string\n        description: DNS検索ドメインのリスト。\n        example: null\n      ExtraHosts:\n        type: array\n        items:\n          type: string\n        description: 追加のホスト名とIPアドレスのマッピングのリスト。\n        example: []\n      GroupAdd:\n        type: array\n        items:\n          type: string\n        description: 追加するグループのリスト。\n        example: null\n      IpcMode:\n        type: string\n        description: IPCモード。\n        example: \"private\"\n      Cgroup:\n        type: string\n        description: cgroupオプション。\n        example: \"\"\n      Links:\n        type: array\n        items:\n          type: string\n        description: 他のコンテナへのリンクのリスト。\n        example: null\n      OomScoreAdj:\n        type: integer\n        description: OOMスコア調整値。\n        example: 0\n      PidMode:\n        type: string\n        description: PIDモード。\n        example: \"\"\n      Privileged:\n        type: boolean\n        description: 特権モードで実行するかどうか。\n        example: false\n      PublishAllPorts:\n        type: boolean\n        description: すべてのポートを公開するかどうか。\n        example: false\n      ReadonlyRootfs:\n        type: boolean\n        description: 読み取り専用のルートファイルシステムを使用するかどうか。\n        example: false\n      SecurityOpt:\n        type: array\n        items:\n          type: string\n        description: セキュリティオプションのリスト。\n        example: null\n      UTSMode:\n        type: string\n        description: UTSモード。\n        example: \"\"\n      UsernsMode:\n        type: string\n        description: ユーザ名前空間モード。\n        example: \"\"\n      ShmSize:\n        type: integer\n        description: 共有メモリのサイズ。\n        example: 67108864\n      Runtime:\n        type: string\n        description: ランタイム。\n        example: \"runc\"\n      Isolation:\n        type: string\n        description: アイソレーションモード。\n        example: \"\"\n      CpuShares:\n        type: integer\n        description: CPU共有の設定。\n        example: 0\n      Memory:\n        type: integer\n        description: メモリの制限。\n        example: 0\n      NanoCpus:\n        type: integer\n        description: NanoCPUsの設定。\n        example: 0\n      CgroupParent:\n        type: string\n        description: cgroup親の設定。\n        example: \"\"\n      BlkioWeight:\n        type: integer\n        description: ブロックI/Oのウェイト。\n        example: 0\n      BlkioWeightDevice:\n        type: array\n        items:\n          type: object\n        description: ブロックI/Oウェイトデバイスのリスト。\n        example: null\n      BlkioDeviceReadBps:\n        type: array\n        items:\n          type: object\n        description: ブロックI/Oデバイスの読み取り速度（バイト/秒）のリスト。\n        example: null\n      BlkioDeviceWriteBps:\n        type: array\n        items:\n          type: object\n        description: ブロックI/Oデバイスの書き込み速度（バイト/秒）のリスト。\n        example: null\n      BlkioDeviceReadIOps:\n        type: array\n        items:\n          type: object\n        description: ブロックI/Oデバイスの読み取り速度（I/O操作/秒）のリスト。\n        example: null\n      BlkioDeviceWriteIOps:\n        type: array\n        items:\n          type: object\n        description: ブロックI/Oデバイスの書き込み速度（I/O操作/秒）のリスト。\n        example: null\n      CpuPeriod:\n        type: integer\n        description: CPUの周期。\n        example: 0\n      CpuQuota:\n        type: integer\n        description: CPUクォータ。\n        example: 0\n      CpuRealtimePeriod:\n        type: integer\n        description: CPUリアルタイム周期。\n        example: 0\n      CpuRealtimeRuntime:\n        type: integer\n        description: CPUリアルタイムランタイム。\n        example: 0\n      CpusetCpus:\n        type: string\n        description: CPUセットのCPU。\n        example: \"\"\n      CpusetMems:\n        type: string\n        description: CPUセットのメモリ。\n        example: \"\"\n      Devices:\n        type: array\n        items:\n          type: object\n        description: デバイスのリスト。\n        example: null\n      DeviceCgroupRules:\n        type: array\n        items:\n          type: string\n        description: デバイスcgroupルールのリスト。\n        example: null\n      DeviceRequests:\n        type: array\n        items:\n          type: object\n        description: デバイスリクエストのリスト。\n        example: null\n      MemoryReservation:\n        type: integer\n        description: メモリの予約。\n        example: 0\n      MemorySwap:\n        type: integer\n        description: メモリのスワップ設定。\n        example: 0\n      MemorySwappiness:\n        type: integer\n        description: メモリのスワッピネス。\n        example: null\n      OomKillDisable:\n        type: boolean\n        description: OOMキルを無効にするかどうか。\n        example: false\n      PidsLimit:\n        type: integer\n        description: PIDの制限。\n        example: null\n      Ulimits:\n        type: array\n        items:\n          type: object\n        description: ulimitの設定。\n        example: null\n      CpuCount:\n        type: integer\n        description: CPUの数。\n        example: 0\n      CpuPercent:\n        type: integer\n        description: CPUのパーセンテージ。\n        example: 0\n      IOMaximumIOps:\n        type: integer\n        description: 最大I/O操作数。\n        example: 0\n      IOMaximumBandwidth:\n        type: integer\n        description: 最大バンド幅。\n        example: 0\n      MaskedPaths:\n        type: array\n        items:\n          type: string\n        description: マスクされたパスのリスト。\n        example:\n          [\n            \"/proc/asound\",\n            \"/proc/acpi\",\n            \"/proc/kcore\",\n            \"/proc/keys\",\n            \"/proc/latency_stats\",\n            \"/proc/timer_list\",\n            \"/proc/timer_stats\",\n            \"/proc/sched_debug\",\n            \"/proc/scsi\",\n            \"/sys/firmware\",\n          ]\n      ReadonlyPaths:\n        type: array\n        items:\n          type: string\n        description: 読み取り専用のパスのリスト。\n        example:\n          [\n            \"/proc/bus\",\n            \"/proc/fs\",\n            \"/proc/irq\",\n            \"/proc/sys\",\n            \"/proc/sysrq-trigger\",\n          ]\n  GraphDriver:\n    type: object\n    description: グラフドライバーのデータ。\n    properties:\n      Data:\n        type: object\n        description: グラフドライバーのデータ。\n        properties:\n          LowerDir:\n            type: string\n            description: LowerDirのパス。\n            example: \"/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c-init/diff:/home/docker/overlay2/180ea9e2448689419cb3ffa2b4fb48c18676d0fa4529982a8bf04f1193fe3f96/diff:/home/docker/overlay2/de5921af205703308a71cda4b33225a81f5de21002310ac80f962c031c9e84fb/diff:/home/docker/overlay2/8e6f007f5af6742863aff11a0c4f69a2cb963fbf932f0e2a3b9411c48bec9c85/diff:/home/docker/overlay2/b72fb5eb7e785933c03c6f9329948778b89dd663d2dff2c766b53ae97da606ec/diff:/home/docker/overlay2/feff8433af2fee0f948b69308832c49fea9f6612dc08717b410a1bfee6004667/diff:/home/docker/overlay2/93bb59e59c6a58b8844bee5c5b9c130cb5f7502707553a84a0b0ff848c4bfddf/diff:/home/docker/overlay2/1515191def9e1afb6d97623752cd731c448b6f3a9f21585d89c6775f6f6a7892/diff:/home/docker/overlay2/17ee2e88fef4ec08a2268963f63f9f975a839b0afb5d9bef184146113481a73e/diff\"\n          MergedDir:\n            type: string\n            description: MergedDirのパス。\n            example: \"/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/merged\"\n          UpperDir:\n            type: string\n            description: UpperDirのパス。\n            example: \"/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/diff\"\n          WorkDir:\n            type: string\n            description: WorkDirのパス。\n            example: \"/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/work\"\n      Name:\n        type: string\n        description: グラフドライバーの名前。\n        example: \"overlay2\"\n  Mounts:\n    type: array\n    description: マウントのリスト。\n    items:\n      type: object\n      properties:\n        Type:\n          type: string\n          description: マウントタイプ（例：bind、volume、tmpfs）。\n          example: \"bind\"\n        Source:\n          type: string\n          description: マウントのソースパス。\n          example: \"/var/samba/public/MediaHarborFrontend/DB/data\"\n        Destination:\n          type: string\n          description: マウントの宛先パス。\n          example: \"/var/lib/mysql\"\n        Mode:\n          type: string\n          description: マウントモード（例：ro、rw）。\n          example: \"rw\"\n        RW:\n          type: boolean\n          description: マウントが読み書き可能かどうかを示します。\n          example: true\n        Propagation:\n          type: string\n          description: マウントの伝播モード。\n          example: \"rprivate\"\n        Config:\n          type: object\n          description: コンテナの設定。\n          properties:\n            Hostname:\n              type: string\n              description: コンテナのホスト名。\n              example: \"fd8b7d18b8fe\"\n            Domainname:\n              type: string\n              description: コンテナのドメイン名。\n              example: \"\"\n            User:\n              type: string\n              description: コンテナのユーザー名。\n              example: \"\"\n            AttachStdin:\n              type: boolean\n              description: 標準入力をアタッチするかどうか。\n              example: false\n            AttachStdout:\n              type: boolean\n              description: 標準出力をアタッチするかどうか。\n              example: true\n            AttachStderr:\n              type: boolean\n              description: 標準エラーをアタッチするかどうか。\n              example: true\n            ExposedPorts:\n              type: object\n              description: 公開ポートの設定。\n              properties:\n                \"3306/tcp\":\n                  type: object\n                  description: TCPポート3306の設定。\n                  example: {}\n            Tty:\n              type: boolean\n              description: TTYを使用するかどうか。\n              example: false\n            OpenStdin:\n              type: boolean\n              description: 標準入力を開くかどうか。\n              example: false\n            StdinOnce:\n              type: boolean\n              description: 標準入力を一度だけ開くかどうか。\n              example: false\n            Env:\n              type: array\n              items:\n                type: string\n              description: 環境変数のリスト。\n              example:\n                [\n                  \"MARIADB_ROOT_PASSWORD_HASH=*7932903C4D7035C6CB4F5FE4CD267A9F1D7F39C9\",\n                  \"MARIADB_DATABASE=mediaharbor\",\n                  \"MARIADB_USER=mediaharbor\",\n                  \"MARIADB_PASSWORD_HASH=*98862F42AC6125B3B646E116DD3DB4FB5252A6AA\",\n                  \"MARIADB_HOST=%\",\n                  'TZ=\"Asia/Tokyo\"',\n                  \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\",\n                  \"GOSU_VERSION=1.14\",\n                  \"LANG=C.UTF-8\",\n                  \"MARIADB_VERSION=1:11.1.2+maria~ubu2204\",\n                ]\n            Cmd:\n              type: array\n              items:\n                type: string\n              description: コンテナのコマンド。\n              example: [\"mariadbd\"]\n            Image:\n              type: string\n              description: コンテナのイメージ。\n              example: \"mariadb:11\"\n            Volumes:\n              type: object\n              description: ボリュームの設定。\n              properties:\n                \"/etc/mysql/conf.d/my.cnf\":\n                  type: object\n                  description: my.cnfの設定。\n                  example: {}\n                \"/var/lib/mysql\":\n                  type: object\n                  description: MySQLのデータディレクトリの設定。\n                  example: {}\n            WorkingDir:\n              type: string\n              description: コンテナの作業ディレクトリ。\n              example: \"\"\n            Entrypoint:\n              type: array\n              items:\n                type: string\n              description: コンテナのエントリーポイント。\n              example: [\"docker-entrypoint.sh\"]\n            OnBuild:\n              type: array\n              items:\n                type: string\n              description: ONBUILDイベントのリスト。\n              example: null\n            Labels:\n              type: object\n              description: コンテナのラベル。\n              properties:\n                com.docker.compose.config-hash:\n                  type: string\n                  description: Docker Composeの設定ハッシュ。\n                  example: \"1d7fbc5756c5ff6a0460c6c22e93a597044096b5f2da23ff1c9fe672e371e30b\"\n                com.docker.compose.container-number:\n                  type: string\n                  description: Docker Composeのコンテナ番号。\n                  example: \"1\"\n                com.docker.compose.depends_on:\n                  type: string\n                  description: 依存する他のサービス。\n                  example: \"\"\n                com.docker.compose.image:\n                  type: string\n                  description: コンテナのイメージのSHA256ハッシュ。\n                  example: \"sha256:871a9153c1842e3b480cb1be691c64151bc96a5de2cc8039470d31e32ff0a177\"\n                com.docker.compose.oneoff:\n                  type: string\n                  description: 一回限りのタスクかどうか。\n                  example: \"False\"\n                com.docker.compose.project:\n                  type: string\n                  description: Docker Composeプロジェクトの名前。\n                  example: \"mediaharborfrontend\"\n                com.docker.compose.project.config_files:\n                  type: string\n                  description: Docker Composeの設定ファイルのリスト。\n                  example: \"/var/samba/public/MediaHarborFrontend/docker-compose.yml\"\n                com.docker.compose.project.working_dir:\n                  type: string\n                  description: Docker Composeの作業ディレクトリ。\n                  example: \"/var/samba/public/MediaHarborFrontend\"\n                com.docker.compose.service:\n                  type: string\n                  description: Docker Composeのサービス名。\n                  example: \"db\"\n                com.docker.compose.version:\n                  type: string\n                  description: Docker Composeのバージョン。\n                  example: \"2.12.2\"\n                org.opencontainers.image.authors:\n                  type: string\n                  description: イメージの作成者。\n                  example: \"MariaDB Community\"\n                org.opencontainers.image.base.name:\n                  type: string\n                  description: ベースイメージの名前。\n                  example: \"docker.io/library/ubuntu:jammy\"\n                org.opencontainers.image.description:\n                  type: string\n                  description: イメージの説明。\n                  example: \"MariaDB Database for relational SQL\"\n                org.opencontainers.image.documentation:\n                  type: string\n                  description: イメージのドキュメンテーションURL。\n                  example: \"https://hub.docker.com/_/mariadb/\"\n                org.opencontainers.image.licenses:\n                  type: string\n                  description: イメージのライセンス。\n                  example: \"GPL-2.0\"\n                org.opencontainers.image.ref.name:\n                  type: string\n                  description: イメージのリファレンス名。\n                  example: \"ubuntu\"\n                org.opencontainers.image.source:\n                  type: string\n                  description: イメージのソースURL。\n                  example: \"https://github.com/MariaDB/mariadb-docker\"\n                org.opencontainers.image.title:\n                  type: string\n                  description: イメージのタイトル。\n                  example: \"MariaDB Database\"\n                org.opencontainers.image.url:\n                  type: string\n                  description: イメージのURL。\n                  example: \"https://github.com/MariaDB/mariadb-docker\"\n                org.opencontainers.image.vendor:\n                  type: string\n                  description: イメージのベンダー。\n                  example: \"MariaDB Community\"\n                org.opencontainers.image.version:\n                  type: string\n                  description: イメージのバージョン。\n                  example: \"11.1.2\"\n        NetworkSettings:\n          type: object\n          description: ネットワークの設定。\n          properties:\n            Bridge:\n              type: string\n              description: ブリッジネットワークの名前。\n              example: \"\"\n            SandboxID:\n              type: string\n              description: サンドボックスID。\n              example: \"dab8c333826eef62a5c6887206697b0bd40208350b58724a55cbeaf55c161a75\"\n            HairpinMode:\n              type: boolean\n              description: ヘアピンモード。\n              example: false\n            LinkLocalIPv6Address:\n              type: string\n              description: リンクローカルIPv6アドレス。\n              example: \"\"\n            LinkLocalIPv6PrefixLen:\n              type: integer\n              description: リンクローカルIPv6プレフィックス長。\n              example: 0\n            Ports:\n              type: object\n              description: ポートの設定。\n              properties:\n                \"3306/tcp\":\n                  type: array\n                  items:\n                    type: object\n                  description: TCPポート3306の設定。\n                  example:\n                    - HostIp: \"0.0.0.0\"\n                      HostPort: \"3306\"\n                    - HostIp: \"::\"\n                      HostPort: \"3306\"\n            SandboxKey:\n              type: string\n              description: サンドボックスキー。\n              example: \"/var/run/docker/netns/dab8c333826e\"\n            SecondaryIPAddresses:\n              type: array\n              items:\n                type: string\n              description: 2次IPアドレスのリスト。\n              example: null\n            SecondaryIPv6Addresses:\n              type: array\n              items:\n                type: string\n              description: 2次IPv6アドレスのリスト。\n              example: null\n            EndpointID:\n              type: string\n              description: エンドポイントID。\n              example: \"\"\n            Gateway:\n              type: string\n              description: ゲートウェイ。\n              example: \"\"\n            GlobalIPv6Address:\n              type: string\n              description: グローバルIPv6アドレス。\n              example: \"\"\n            GlobalIPv6PrefixLen:\n              type: integer\n              description: グローバルIPv6プレフィックス長。\n              example: 0\n            IPAddress:\n              type: string\n              description: IPアドレス。\n              example: \"\"\n            IPPrefixLen:\n              type: integer\n              description: IPプレフィックス長。\n              example: 0\n            IPv6Gateway:\n              type: string\n              description: IPv6ゲートウェイ。\n              example: \"\"\n            MacAddress:\n              type: string\n              description: MACアドレス。\n              example: \"\"\n            Networks:\n              type: object\n              description: ネットワークの設定。\n              properties:\n                mediaharborfrontend_default:\n                  type: object\n                  description: mediaharborfrontend_defaultネットワークの設定。\n                  properties:\n                    IPAMConfig:\n                      type: object\n                      description: IPAM設定。\n                      example: null\n                    Links:\n                      type: array\n                      items:\n                        type: string\n                      description: リンクのリスト。\n                      example: null\n                    Aliases:\n                      type: array\n                      items:\n                        type: string\n                      description: エイリアスのリスト。\n                      example: [\"db\", \"db\", \"fd8b7d18b8fe\"]\n                    NetworkID:\n                      type: string\n                      description: ネットワークID。\n                      example: \"e3f1da74b58bb32ba05a58306eb342c8f161025e13d117a5628b196b7a450d00\"\n                    EndpointID:\n                      type: string\n                      description: エンドポイントID。\n                      example: \"3d39b3eeee4be7872fb3847766022d8110e37d00a45895c356a8c520314a8c95\"\n                    Gateway:\n                      type: string\n                      description: ゲートウェイ。\n                      example: \"172.31.0.1\"\n                    IPAddress:\n                      type: string\n                      description: IPアドレス。\n                      example: \"172.31.0.4\"\n                    IPPrefixLen:\n                      type: integer\n                      description: IPプレフィックス長。\n                      example: 16\n                    IPv6Gateway:\n                      type: string\n                      description: IPv6ゲートウェイ。\n                      example: \"\"\n                    GlobalIPv6Address:\n                      type: string\n                      description: グローバルIPv6アドレス。\n                      example: \"\"\n                    GlobalIPv6PrefixLen:\n                      type: integer\n                      description: グローバルIPv6プレフィックス長。\n                      example: 0\n                    MacAddress:\n                      type: string\n                      description: MACアドレス。\n                      example: \"02:42:ac:1f:00:04\"\n                    DriverOpts:\n                      type: object\n                      description: ドライバーオプション。\n                      example: null\n"

コンテナログを取得

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <string>

Example: id=123e4567-e89b-12d3-a456-426614174000

コンテナID

Responses

Response Headers
Content-Type	string Example: "text/plain" コンテンツタイプ
Transfer-Encoding	string Example: "chunked" 転送エンコーディング

Response Schema: text/plain

string

リアルタイムでコンテナログをストリーミング配信タイムスタンプ付きのログ行が継続的に送信される

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/container/log?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

コンテナログをダウンロード

Authorizations:

api_key_adminapi_key_app

query Parameters

id

required

string <string>

Example: id=123e4567-e89b-12d3-a456-426614174000

コンテナID

Responses

Response Headers
Content-Type	string Example: "text/plain" コンテンツタイプ
Content-Disposition	string Example: "attachment; filename=MHLogYYYYMMDDhhmmss.log" ファイルとしてダウンロードするためのヘッダー

Response Schema: text/plain

string <binary>

ログ

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/container/log-dl?id=123e4567-e89b-12d3-a456-426614174000' \
  -H 'x-api-key: YOUR_API_KEY'

ディスプレイ情報を取得

DRM（Direct Rendering Manager）を使用してディスプレイ接続状態を取得します

Authorizations:

api_key_admin

Responses

Response Schema: application/json

status

required

integer

ステータスコード

message

required

string

ステータスメッセージ

required

Array of objects

ディスプレイ情報の配列

Array

connector_id required	integer コネクターID
name required	string ディスプレイ名
isConnected required	boolean 接続状態
resolution required	string 現在の解像度
type required	string Enum: "HDMI" "DisplayPort" "eDP" ディスプレイタイプ

error

required

string or null

エラーメッセージ（正常時はnull）

Response Schema: application/json

status required	integer ステータスコード
message required	string ステータスメッセージ
data required	string or null データ（エラー時はnull）
error required	string エラーメッセージ

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/drm' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200
500

Content type

application/json

{"status": 200,
"message": "OK",
"data": [{"connector_id": 1,
"name": "HDMI-A-1",
"isConnected": true,
"resolution": "1920x1080",
"type": "HDMI"
}
],
"error": null
}

Log

監視ログを登録

監視ログを登録する。

Authorizations:

api_key_adminapi_key_app

Request Body schema: application/json

Array

date	string <date-time> ログ日時 ※未指定の場合は現在日時が入る
source_id	string <uuid> ソースID
patrol_item_source_id	string or null <uuid> 巡回中の切替元ソースID
log_id required	string^[0-9a-fA-F]{8}$ ログID
jsondata	string JSONデータ

Responses

Request samples

Payload
cURL

Content type

application/json

[{"date": "2024-03-19T13:51:38Z",
"source_id": "cdd55dc4-2107-41f0-810c-a06495c841c1",
"patrol_item_source_id": "3a3b80ef-c138-4926-9617-169815700af5",
"log_id": "00200201",
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
}
]

監視ログを取得

指定したタイプの監視ログを取得指定が無い場合は全て取得

Authorizations:

api_key_adminapi_key_app

query Parameters

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

※未指定時は全て

level

string

Example: level=0,1,2

ログレベル複数指定可能で指定した値のレベルのログが取得される
※未指定時は0~6のログが取得

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

qty

string

Example: qty=100

取得件数
※未指定時は100件

from

string <date-time>

Example: from=2019-08-24T14:15:22Z

取得開始日時
※未指定時は全て

to

string <date-time>

Example: to=2019-08-24T14:15:22Z

取得終了日時
※未指定時は全て

query

string

Example: query=freeze

ソース名、メッセージでキーワード検索
※未指定時は全て

order

string

Example: order=asc

取得方向
asc=昇順
desc=降順
※未指定時はdesc

nextToken

string

Example: nextToken=eyJ2ZXJzaW9uIjoxLCJ0b2tlbiI6IjIwMjItMDMtMjJUMTg6MjA6MjIuMjAwMDAwMFoiLCJzdGF0ZSI6MH0

次のページのトークン

Responses

Response Schema: application/json

required

Array of objects

ログ一覧

Array

id

integer <int64>

ID

date

string <date-time>

監視日時

source_id

string or null <uuid>

ソースID

patrol_item_source_id

string or null <uuid>

巡回中の切替元ソースID

log_id

string^[0-9a-fA-F]{8}$

ログID

object

ソース情報

name	string ソース名
protocol_type_id	integer プロトコルタイプID 1=srt 2=file 3=rtp 4=hls 5=streamlink 6=colorbar 7=browser 8=zixi 9=rist 10=ndi 11=st2110 12=rtmp 13=aes67 14=jpegxs 15=mhb 16=patrol

object

詳細情報

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

string

ログメッセージ

message_en

string

ログメッセージ(英語)

jsondata

string

JSONデータ

nextToken

required

string or null

次のページのトークン

Request samples

cURL

curl -X 'GET' \
  'http://<ServerAddress>/api/monlog?type=SYS&level=0%2C1%2C2&qty=100&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&query=freeze&order=asc&nextToken=eyJ2ZXJzaW9uIjoxLCJ0b2tlbiI6IjIwMjItMDMtMjJUMTg6MjA6MjIuMjAwMDAwMFoiLCJzdGF0ZSI6MH0' \
  -H 'x-api-key: YOUR_API_KEY'

Response samples

200

Content type

application/json

{"logs": [{"id": 0,
"date": "2019-08-24T14:15:22Z",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"patrol_item_source_id": "3a3b80ef-c138-4926-9617-169815700af5",
"log_id": "00200201",
"source": {"name": "string",
"protocol_type_id": 1
},
"details": {"type": "VA",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected"
},
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
}
],
"nextToken": "eyJ2ZXJzaW9uIjoxLCJ0b2tlbiI6IjIwMjItMDMtMjJUMTg6MjA6MjIuMjAwMDAwMFoiLCJzdGF0ZSI6MH0="
}