-
Notifications
You must be signed in to change notification settings - Fork 0
/
sdfobject-audio_clip.swagger.json
116 lines (116 loc) · 3.3 KB
/
sdfobject-audio_clip.swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{
"swagger": "2.0",
"info": {
"title": "OMA/IPSO Audio Clip (Object ID 3339)",
"version": "2022-02-22",
"license": {
"name": "BSD-3-Clause",
"x-copyright": "Copyright 2019 Open Mobile Alliance."
}
},
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/Omaipsoaudioclipobjectid3339ResURI": {
"get": {
"description": " This IPSO object should be used for a speaker that plays a pre-recorded audio clip or an audio output that is sent elsewhere. For example, an elevator which announces the floor of the building. A resource is provided to store the clip, a dimmer resource controls the relative sound level of the playback, and a duration resource limits the maximum playback time. After the duration time is reached, any remaining samples in the clip are ignored, and the clip player will be ready to play another clip.",
"parameters": [
{
"$ref": "#/parameters/interface"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Omaipsoaudioclipobjectid3339"
}
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": [
"oic.if.s",
"oic.if.baseline"
]
}
},
"definitions": {
"Omaipsoaudioclipobjectid3339": {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": [
"oic.r.o.audio.clip"
],
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"n": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"if": {
"description": "The OCF Interface set supported by this Resource.",
"items": {
"enum": [
"oic.if.s",
"oic.if.baseline"
],
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"Clip": {
"description": "Audio clip that is playable (e.g., a short audio recording indicating the floor in an elevator).",
"x-label": "Clip",
"x-sdfType": "byte-string",
"type": "string"
},
"Level": {
"description": "Used to represent a level control such as audio volume.",
"x-label": "Level",
"maximum": 100,
"minimum": 0,
"type": "number",
"x-unit": "/100"
},
"Duration": {
"description": "The duration of the sound once trigger.",
"x-label": "Duration",
"type": "number",
"x-unit": "s"
},
"Application_Type": {
"description": "The application type of the sensor or actuator as a string depending on the use case.",
"x-label": "Application Type",
"type": "string"
}
},
"type": "object",
"required": [
"Clip"
]
}
}
}