Package com.vonage.client.video
Class ListStreamCompositionsRequest.Builder
java.lang.Object
com.vonage.client.video.ListStreamCompositionsRequest.Builder
- Enclosing class:
ListStreamCompositionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the ListStreamCompositionsRequest with this builder's settings.count(int count) Set a count query parameter to limit the number of composition to be returned.offset(int offset) Set an offset query parameters to specify the index offset of the first composition. 0 is offset of the most recently started composition (excluding deleted compositions). 1 is the offset of the composition that started prior to the most recent composition.Set a sessionId query parameter to list compositions for a specific session ID.
-
Method Details
-
offset
Set an offset query parameters to specify the index offset of the first composition. 0 is offset of the most recently started composition (excluding deleted compositions). 1 is the offset of the composition that started prior to the most recent composition. The default value is 0.- Parameters:
offset- The offset index.- Returns:
- This builder with the offset setting.
-
count
Set a count query parameter to limit the number of composition to be returned. The default number of composition returned is 50 (or fewer, if there are fewer than 50 compositions). The maximum number of composition the call will return is 1000.- Parameters:
count- The number of results to return, between 0 and 1000.- Returns:
- This builder with the count setting.
-
sessionId
Set a sessionId query parameter to list compositions for a specific session ID. This is useful when listing multiple compositions for sessions withStreamMode.AUTO.- Parameters:
sessionId- The session ID to filter by.- Returns:
- This builder with the sessionId setting.
-
build
Builds the ListStreamCompositionsRequest with this builder's settings.- Returns:
- A new
ListStreamCompositionsRequestinstance.
-