/
com.azure.mixedreality.remoterendering.RemoteRenderingClient.yml
292 lines (292 loc) · 29 KB
/
com.azure.mixedreality.remoterendering.RemoteRenderingClient.yml
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
### YamlMime:JavaType
uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient"
name: "RemoteRenderingClient"
nameWithType: "RemoteRenderingClient"
summary: "Client to communicate with remote rendering service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **RemoteRenderingClient**"
methods:
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginConversion(java.lang.String,com.azure.mixedreality.remoterendering.models.AssetConversionOptions)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginConversion(String conversionId, AssetConversionOptions options)"
name: "beginConversion(String conversionId, AssetConversionOptions options)"
nameWithType: "RemoteRenderingClient.beginConversion(String conversionId, AssetConversionOptions options)"
summary: "Starts a conversion using an asset stored in an Azure Blob Storage account."
parameters:
- description: "An ID uniquely identifying the conversion for the given account. The ID is case sensitive,\n can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain\n more than 256 characters."
name: "conversionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The conversion options."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionOptions?alt=com.azure.mixedreality.remoterendering.models.AssetConversionOptions&text=AssetConversionOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<AssetConversion,AssetConversion> beginConversion(String conversionId, AssetConversionOptions options)"
desc: "Starts a conversion using an asset stored in an Azure Blob Storage account. If the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided. Documentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the \\[documentation\\](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account\\#link-storage-accounts).\n\nAll files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix."
returns:
description: "the conversion."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginConversion(java.lang.String,com.azure.mixedreality.remoterendering.models.AssetConversionOptions,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginConversion(String conversionId, AssetConversionOptions options, Context context)"
name: "beginConversion(String conversionId, AssetConversionOptions options, Context context)"
nameWithType: "RemoteRenderingClient.beginConversion(String conversionId, AssetConversionOptions options, Context context)"
summary: "Starts a conversion using an asset stored in an Azure Blob Storage account."
parameters:
- description: "An ID uniquely identifying the conversion for the given account. The ID is case sensitive,\n can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain\n more than 256 characters."
name: "conversionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The conversion options."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionOptions?alt=com.azure.mixedreality.remoterendering.models.AssetConversionOptions&text=AssetConversionOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<AssetConversion,AssetConversion> beginConversion(String conversionId, AssetConversionOptions options, Context context)"
desc: "Starts a conversion using an asset stored in an Azure Blob Storage account. If the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided. Documentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the \\[documentation\\](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account\\#link-storage-accounts).\n\nAll files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix."
returns:
description: "the conversion."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(String sessionId)"
name: "beginSession(String sessionId)"
nameWithType: "RemoteRenderingClient.beginSession(String sessionId)"
summary: "Creates a new rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SyncPoller<RenderingSession,RenderingSession> beginSession(String sessionId)"
desc: "Creates a new rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(java.lang.String,com.azure.mixedreality.remoterendering.models.BeginSessionOptions)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(String sessionId, BeginSessionOptions options)"
name: "beginSession(String sessionId, BeginSessionOptions options)"
nameWithType: "RemoteRenderingClient.beginSession(String sessionId, BeginSessionOptions options)"
summary: "Creates a new rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Options for the session to be created."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.BeginSessionOptions?alt=com.azure.mixedreality.remoterendering.models.BeginSessionOptions&text=BeginSessionOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<RenderingSession,RenderingSession> beginSession(String sessionId, BeginSessionOptions options)"
desc: "Creates a new rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(java.lang.String,com.azure.mixedreality.remoterendering.models.BeginSessionOptions,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.beginSession(String sessionId, BeginSessionOptions options, Context context)"
name: "beginSession(String sessionId, BeginSessionOptions options, Context context)"
nameWithType: "RemoteRenderingClient.beginSession(String sessionId, BeginSessionOptions options, Context context)"
summary: "Creates a new rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Options for the session to be created."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.BeginSessionOptions?alt=com.azure.mixedreality.remoterendering.models.BeginSessionOptions&text=BeginSessionOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<RenderingSession,RenderingSession> beginSession(String sessionId, BeginSessionOptions options, Context context)"
desc: "Creates a new rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.endSession(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.endSession(String sessionId)"
name: "endSession(String sessionId)"
nameWithType: "RemoteRenderingClient.endSession(String sessionId)"
summary: "Stops a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void endSession(String sessionId)"
desc: "Stops a particular rendering session."
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.endSessionWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.endSessionWithResponse(String sessionId, Context context)"
name: "endSessionWithResponse(String sessionId, Context context)"
nameWithType: "RemoteRenderingClient.endSessionWithResponse(String sessionId, Context context)"
summary: "Stops a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Response<Void> endSessionWithResponse(String sessionId, Context context)"
desc: "Stops a particular rendering session."
returns:
description: "The response."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getConversion(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getConversion(String conversionId)"
name: "getConversion(String conversionId)"
nameWithType: "RemoteRenderingClient.getConversion(String conversionId)"
summary: "Gets the status of a previously created asset conversion."
parameters:
- description: "An ID uniquely identifying the conversion for the given account. The ID is case sensitive,\n can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain\n more than 256 characters."
name: "conversionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AssetConversion getConversion(String conversionId)"
desc: "Gets the status of a previously created asset conversion."
returns:
description: "the conversion."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getConversionWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getConversionWithResponse(String conversionId, Context context)"
name: "getConversionWithResponse(String conversionId, Context context)"
nameWithType: "RemoteRenderingClient.getConversionWithResponse(String conversionId, Context context)"
summary: "Gets the status of a previously created asset conversion."
parameters:
- description: "An ID uniquely identifying the conversion for the given account. The ID is case sensitive,\n can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain\n more than 256 characters."
name: "conversionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Response<AssetConversion> getConversionWithResponse(String conversionId, Context context)"
desc: "Gets the status of a previously created asset conversion."
returns:
description: "the conversion."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getSession(java.lang.String)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getSession(String sessionId)"
name: "getSession(String sessionId)"
nameWithType: "RemoteRenderingClient.getSession(String sessionId)"
summary: "Gets properties of a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public RenderingSession getSession(String sessionId)"
desc: "Gets properties of a particular rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getSessionWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.getSessionWithResponse(String sessionId, Context context)"
name: "getSessionWithResponse(String sessionId, Context context)"
nameWithType: "RemoteRenderingClient.getSessionWithResponse(String sessionId, Context context)"
summary: "Gets properties of a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Response<RenderingSession> getSessionWithResponse(String sessionId, Context context)"
desc: "Gets properties of a particular rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listConversions()"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listConversions()"
name: "listConversions()"
nameWithType: "RemoteRenderingClient.listConversions()"
summary: "Gets a list of all conversions."
syntax: "public PagedIterable<AssetConversion> listConversions()"
desc: "Gets a list of all conversions."
returns:
description: "a list of all conversions."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listConversions(com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listConversions(Context context)"
name: "listConversions(Context context)"
nameWithType: "RemoteRenderingClient.listConversions(Context context)"
summary: "Gets a list of all conversions."
parameters:
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedIterable<AssetConversion> listConversions(Context context)"
desc: "Gets a list of all conversions."
returns:
description: "a list of all conversions."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversion?alt=com.azure.mixedreality.remoterendering.models.AssetConversion&text=AssetConversion\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listSessions()"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listSessions()"
name: "listSessions()"
nameWithType: "RemoteRenderingClient.listSessions()"
summary: "Get a list of all rendering sessions."
syntax: "public PagedIterable<RenderingSession> listSessions()"
desc: "Get a list of all rendering sessions."
returns:
description: "a list of all rendering sessions."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listSessions(com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.listSessions(Context context)"
name: "listSessions(Context context)"
nameWithType: "RemoteRenderingClient.listSessions(Context context)"
summary: "Get a list of all rendering sessions."
parameters:
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedIterable<RenderingSession> listSessions(Context context)"
desc: "Get a list of all rendering sessions."
returns:
description: "a list of all rendering sessions."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.updateSession(java.lang.String,com.azure.mixedreality.remoterendering.models.UpdateSessionOptions)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.updateSession(String sessionId, UpdateSessionOptions options)"
name: "updateSession(String sessionId, UpdateSessionOptions options)"
nameWithType: "RemoteRenderingClient.updateSession(String sessionId, UpdateSessionOptions options)"
summary: "Updates a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Options for the session to be updated."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.UpdateSessionOptions?alt=com.azure.mixedreality.remoterendering.models.UpdateSessionOptions&text=UpdateSessionOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public RenderingSession updateSession(String sessionId, UpdateSessionOptions options)"
desc: "Updates a particular rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.updateSessionWithResponse(java.lang.String,com.azure.mixedreality.remoterendering.models.UpdateSessionOptions,com.azure.core.util.Context)"
fullName: "com.azure.mixedreality.remoterendering.RemoteRenderingClient.updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context)"
name: "updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context)"
nameWithType: "RemoteRenderingClient.updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context)"
summary: "Updates a particular rendering session."
parameters:
- description: "An ID uniquely identifying the rendering session for the given account. The ID is case\n sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and\n cannot contain more than 256 characters."
name: "sessionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Options for the session to be updated."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.UpdateSessionOptions?alt=com.azure.mixedreality.remoterendering.models.UpdateSessionOptions&text=UpdateSessionOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to use."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Response<RenderingSession> updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context)"
desc: "Updates a particular rendering session."
returns:
description: "the rendering session."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSession?alt=com.azure.mixedreality.remoterendering.models.RenderingSession&text=RenderingSession\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "Client to communicate with remote rendering service."
metadata: {}
package: "com.azure.mixedreality.remoterendering"
artifact: com.azure:azure-mixedreality-remoterendering:1.1.28