github.com/optim-corp/cios-golang-sdk@v0.5.1/cios/docs/VideostreamingOperationsApi.md (about)

     1  # \VideostreamingOperationsApi
     2  
     3  All URIs are relative to *http://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateVideoStreamsPlay**](VideostreamingOperationsApi.md#CreateVideoStreamsPlay) | **Post** /v2/video_streams/{video_id}/play | 
     8  [**CreateVideoStreamsStop**](VideostreamingOperationsApi.md#CreateVideoStreamsStop) | **Post** /v2/video_streams/{video_id}/stop | 
     9  [**GetVideoStreams**](VideostreamingOperationsApi.md#GetVideoStreams) | **Get** /v2/video_streams/{video_id} | 
    10  [**GetVideoStreamsList**](VideostreamingOperationsApi.md#GetVideoStreamsList) | **Get** /v2/video_streams | 
    11  [**GetVideoStreamsThumbnail**](VideostreamingOperationsApi.md#GetVideoStreamsThumbnail) | **Get** /v2/video_streams/{video_id}/thumbnail | 
    12  [**UpdateStreams**](VideostreamingOperationsApi.md#UpdateStreams) | **Patch** /v2/video_streams/{video_id} | 
    13  
    14  
    15  
    16  ## CreateVideoStreamsPlay
    17  
    18  > SingleRoom CreateVideoStreamsPlay(ctx, videoId).Execute()
    19  
    20  
    21  
    22  ### Example
    23  
    24  ```go
    25  package main
    26  
    27  import (
    28      "context"
    29      "fmt"
    30      "os"
    31      openapiclient "./openapi"
    32  )
    33  
    34  func main() {
    35      videoId := "videoId_example" // string | 
    36  
    37      configuration := openapiclient.NewConfiguration()
    38      api_client := openapiclient.NewAPIClient(configuration)
    39      resp, r, err := api_client.VideostreamingOperationsApi.CreateVideoStreamsPlay(context.Background(), videoId).Execute()
    40      if err.Error() != "" {
    41          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.CreateVideoStreamsPlay``: %v\n", err)
    42          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    43      }
    44      // response from `CreateVideoStreamsPlay`: SingleRoom
    45      fmt.Fprintf(os.Stdout, "Response from `VideostreamingOperationsApi.CreateVideoStreamsPlay`: %v\n", resp)
    46  }
    47  ```
    48  
    49  ### Path Parameters
    50  
    51  
    52  Name | Type | Description  | Notes
    53  ------------- | ------------- | ------------- | -------------
    54  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    55  **videoId** | **string** |  | 
    56  
    57  ### Other Parameters
    58  
    59  Other parameters are passed through a pointer to a apiCreateVideoStreamsPlayRequest struct via the builder pattern
    60  
    61  
    62  Name | Type | Description  | Notes
    63  ------------- | ------------- | ------------- | -------------
    64  
    65  
    66  ### Return type
    67  
    68  [**SingleRoom**](SingleRoom.md)
    69  
    70  ### Authorization
    71  
    72  [bearerAuth](../README.md#bearerAuth)
    73  
    74  ### HTTP request headers
    75  
    76  - **Content-Type**: Not defined
    77  - **Accept**: application/json
    78  
    79  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    80  [[Back to Model list]](../README.md#documentation-for-models)
    81  [[Back to README]](../README.md)
    82  
    83  
    84  ## CreateVideoStreamsStop
    85  
    86  > CreateVideoStreamsStop(ctx, videoId).Execute()
    87  
    88  
    89  
    90  ### Example
    91  
    92  ```go
    93  package main
    94  
    95  import (
    96      "context"
    97      "fmt"
    98      "os"
    99      openapiclient "./openapi"
   100  )
   101  
   102  func main() {
   103      videoId := "videoId_example" // string | 
   104  
   105      configuration := openapiclient.NewConfiguration()
   106      api_client := openapiclient.NewAPIClient(configuration)
   107      resp, r, err := api_client.VideostreamingOperationsApi.CreateVideoStreamsStop(context.Background(), videoId).Execute()
   108      if err.Error() != "" {
   109          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.CreateVideoStreamsStop``: %v\n", err)
   110          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
   111      }
   112  }
   113  ```
   114  
   115  ### Path Parameters
   116  
   117  
   118  Name | Type | Description  | Notes
   119  ------------- | ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121  **videoId** | **string** |  | 
   122  
   123  ### Other Parameters
   124  
   125  Other parameters are passed through a pointer to a apiCreateVideoStreamsStopRequest struct via the builder pattern
   126  
   127  
   128  Name | Type | Description  | Notes
   129  ------------- | ------------- | ------------- | -------------
   130  
   131  
   132  ### Return type
   133  
   134   (empty response body)
   135  
   136  ### Authorization
   137  
   138  [bearerAuth](../README.md#bearerAuth)
   139  
   140  ### HTTP request headers
   141  
   142  - **Content-Type**: Not defined
   143  - **Accept**: Not defined
   144  
   145  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   146  [[Back to Model list]](../README.md#documentation-for-models)
   147  [[Back to README]](../README.md)
   148  
   149  
   150  ## GetVideoStreams
   151  
   152  > SingleVideo GetVideoStreams(ctx, videoId).Execute()
   153  
   154  
   155  
   156  ### Example
   157  
   158  ```go
   159  package main
   160  
   161  import (
   162      "context"
   163      "fmt"
   164      "os"
   165      openapiclient "./openapi"
   166  )
   167  
   168  func main() {
   169      videoId := "videoId_example" // string | 
   170  
   171      configuration := openapiclient.NewConfiguration()
   172      api_client := openapiclient.NewAPIClient(configuration)
   173      resp, r, err := api_client.VideostreamingOperationsApi.GetVideoStreams(context.Background(), videoId).Execute()
   174      if err.Error() != "" {
   175          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.GetVideoStreams``: %v\n", err)
   176          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
   177      }
   178      // response from `GetVideoStreams`: SingleVideo
   179      fmt.Fprintf(os.Stdout, "Response from `VideostreamingOperationsApi.GetVideoStreams`: %v\n", resp)
   180  }
   181  ```
   182  
   183  ### Path Parameters
   184  
   185  
   186  Name | Type | Description  | Notes
   187  ------------- | ------------- | ------------- | -------------
   188  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   189  **videoId** | **string** |  | 
   190  
   191  ### Other Parameters
   192  
   193  Other parameters are passed through a pointer to a apiGetVideoStreamsRequest struct via the builder pattern
   194  
   195  
   196  Name | Type | Description  | Notes
   197  ------------- | ------------- | ------------- | -------------
   198  
   199  
   200  ### Return type
   201  
   202  [**SingleVideo**](SingleVideo.md)
   203  
   204  ### Authorization
   205  
   206  [bearerAuth](../README.md#bearerAuth)
   207  
   208  ### HTTP request headers
   209  
   210  - **Content-Type**: Not defined
   211  - **Accept**: application/json
   212  
   213  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   214  [[Back to Model list]](../README.md#documentation-for-models)
   215  [[Back to README]](../README.md)
   216  
   217  
   218  ## GetVideoStreamsList
   219  
   220  > MultipleVideo GetVideoStreamsList(ctx).ResourceOwnerId(resourceOwnerId).DeviceId(deviceId).IsEnable(isEnable).Execute()
   221  
   222  
   223  
   224  ### Example
   225  
   226  ```go
   227  package main
   228  
   229  import (
   230      "context"
   231      "fmt"
   232      "os"
   233      openapiclient "./openapi"
   234  )
   235  
   236  func main() {
   237      resourceOwnerId := "resourceOwnerId_example" // string | 
   238      deviceId := "deviceId_example" // string |  (optional)
   239      isEnable := "isEnable_example" // string |  (optional)
   240  
   241      configuration := openapiclient.NewConfiguration()
   242      api_client := openapiclient.NewAPIClient(configuration)
   243      resp, r, err := api_client.VideostreamingOperationsApi.GetVideoStreamsList(context.Background()).ResourceOwnerId(resourceOwnerId).DeviceId(deviceId).IsEnable(isEnable).Execute()
   244      if err.Error() != "" {
   245          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.GetVideoStreamsList``: %v\n", err)
   246          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
   247      }
   248      // response from `GetVideoStreamsList`: MultipleVideo
   249      fmt.Fprintf(os.Stdout, "Response from `VideostreamingOperationsApi.GetVideoStreamsList`: %v\n", resp)
   250  }
   251  ```
   252  
   253  ### Path Parameters
   254  
   255  
   256  
   257  ### Other Parameters
   258  
   259  Other parameters are passed through a pointer to a apiGetVideoStreamsListRequest struct via the builder pattern
   260  
   261  
   262  Name | Type | Description  | Notes
   263  ------------- | ------------- | ------------- | -------------
   264   **resourceOwnerId** | **string** |  | 
   265   **deviceId** | **string** |  | 
   266   **isEnable** | **string** |  | 
   267  
   268  ### Return type
   269  
   270  [**MultipleVideo**](MultipleVideo.md)
   271  
   272  ### Authorization
   273  
   274  [bearerAuth](../README.md#bearerAuth)
   275  
   276  ### HTTP request headers
   277  
   278  - **Content-Type**: Not defined
   279  - **Accept**: application/json
   280  
   281  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   282  [[Back to Model list]](../README.md#documentation-for-models)
   283  [[Back to README]](../README.md)
   284  
   285  
   286  ## GetVideoStreamsThumbnail
   287  
   288  > *os.File GetVideoStreamsThumbnail(ctx, videoId).Execute()
   289  
   290  
   291  
   292  ### Example
   293  
   294  ```go
   295  package main
   296  
   297  import (
   298      "context"
   299      "fmt"
   300      "os"
   301      openapiclient "./openapi"
   302  )
   303  
   304  func main() {
   305      videoId := "videoId_example" // string | 
   306  
   307      configuration := openapiclient.NewConfiguration()
   308      api_client := openapiclient.NewAPIClient(configuration)
   309      resp, r, err := api_client.VideostreamingOperationsApi.GetVideoStreamsThumbnail(context.Background(), videoId).Execute()
   310      if err.Error() != "" {
   311          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.GetVideoStreamsThumbnail``: %v\n", err)
   312          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
   313      }
   314      // response from `GetVideoStreamsThumbnail`: *os.File
   315      fmt.Fprintf(os.Stdout, "Response from `VideostreamingOperationsApi.GetVideoStreamsThumbnail`: %v\n", resp)
   316  }
   317  ```
   318  
   319  ### Path Parameters
   320  
   321  
   322  Name | Type | Description  | Notes
   323  ------------- | ------------- | ------------- | -------------
   324  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   325  **videoId** | **string** |  | 
   326  
   327  ### Other Parameters
   328  
   329  Other parameters are passed through a pointer to a apiGetVideoStreamsThumbnailRequest struct via the builder pattern
   330  
   331  
   332  Name | Type | Description  | Notes
   333  ------------- | ------------- | ------------- | -------------
   334  
   335  
   336  ### Return type
   337  
   338  [***os.File**](*os.File.md)
   339  
   340  ### Authorization
   341  
   342  [bearerAuth](../README.md#bearerAuth)
   343  
   344  ### HTTP request headers
   345  
   346  - **Content-Type**: Not defined
   347  - **Accept**: image/png
   348  
   349  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   350  [[Back to Model list]](../README.md#documentation-for-models)
   351  [[Back to README]](../README.md)
   352  
   353  
   354  ## UpdateStreams
   355  
   356  > SingleVideo UpdateStreams(ctx, videoId).VideoUpdateRequest(videoUpdateRequest).Execute()
   357  
   358  
   359  
   360  ### Example
   361  
   362  ```go
   363  package main
   364  
   365  import (
   366      "context"
   367      "fmt"
   368      "os"
   369      openapiclient "./openapi"
   370  )
   371  
   372  func main() {
   373      videoId := "videoId_example" // string | 
   374      videoUpdateRequest := *openapiclient.NewVideoUpdateRequest() // VideoUpdateRequest | 
   375  
   376      configuration := openapiclient.NewConfiguration()
   377      api_client := openapiclient.NewAPIClient(configuration)
   378      resp, r, err := api_client.VideostreamingOperationsApi.UpdateStreams(context.Background(), videoId).VideoUpdateRequest(videoUpdateRequest).Execute()
   379      if err.Error() != "" {
   380          fmt.Fprintf(os.Stderr, "Error when calling `VideostreamingOperationsApi.UpdateStreams``: %v\n", err)
   381          fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
   382      }
   383      // response from `UpdateStreams`: SingleVideo
   384      fmt.Fprintf(os.Stdout, "Response from `VideostreamingOperationsApi.UpdateStreams`: %v\n", resp)
   385  }
   386  ```
   387  
   388  ### Path Parameters
   389  
   390  
   391  Name | Type | Description  | Notes
   392  ------------- | ------------- | ------------- | -------------
   393  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   394  **videoId** | **string** |  | 
   395  
   396  ### Other Parameters
   397  
   398  Other parameters are passed through a pointer to a apiUpdateStreamsRequest struct via the builder pattern
   399  
   400  
   401  Name | Type | Description  | Notes
   402  ------------- | ------------- | ------------- | -------------
   403  
   404   **videoUpdateRequest** | [**VideoUpdateRequest**](VideoUpdateRequest.md) |  | 
   405  
   406  ### Return type
   407  
   408  [**SingleVideo**](SingleVideo.md)
   409  
   410  ### Authorization
   411  
   412  [bearerAuth](../README.md#bearerAuth)
   413  
   414  ### HTTP request headers
   415  
   416  - **Content-Type**: application/json
   417  - **Accept**: application/json
   418  
   419  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   420  [[Back to Model list]](../README.md#documentation-for-models)
   421  [[Back to README]](../README.md)
   422