Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions conference-to-stream/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Fishjam ID or full URL (e.g. your-id or https://fishjam.io/api/v1/connect/your-id)
FISHJAM_ID=your-fishjam-id

# Fishjam management token
FISHJAM_MANAGEMENT_TOKEN=your-management-token

# Composition API base URL (default: https://sandbox-rtc.fishjam.io)
COMPOSITION_API_URL=https://sandbox-rtc.fishjam.io

# Backend port (default: 8080)
PORT=8080

# Frontend: backend URL
VITE_BACKEND_URL=http://localhost:8080
2 changes: 2 additions & 0 deletions conference-to-stream/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Env file
.env
281 changes: 281 additions & 0 deletions conference-to-stream/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
# Go API client for openapi

Real-time video compositing

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```go
import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `openapi.ContextServerIndex` of type `int`.

```go
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `openapi.ContextServerVariables` of type `map[string]string`.

```go
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `openapi.ContextOperationServerIndices` and `openapi.ContextOperationServerVariables` context maps.

```go
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```

## Documentation for API Endpoints

All URIs are relative to *https://rtc.fishjam.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CompositionAPI* | [**CreateComposition**](docs/CompositionAPI.md#createcomposition) | **Post** /api/composition |
*CompositionAPI* | [**DeleteComposition**](docs/CompositionAPI.md#deletecomposition) | **Delete** /api/composition/{composition_id} |
*ControlRequestAPI* | [**Reset**](docs/ControlRequestAPI.md#reset) | **Post** /api/composition/{composition_id}/reset |
*ControlRequestAPI* | [**Start**](docs/ControlRequestAPI.md#start) | **Post** /api/composition/{composition_id}/start |
*RegisterRequestAPI* | [**RegisterFont**](docs/RegisterRequestAPI.md#registerfont) | **Post** /api/composition/{composition_id}/font/register |
*RegisterRequestAPI* | [**RegisterImage**](docs/RegisterRequestAPI.md#registerimage) | **Post** /api/composition/{composition_id}/image/{image_id}/register |
*RegisterRequestAPI* | [**RegisterInput**](docs/RegisterRequestAPI.md#registerinput) | **Post** /api/composition/{composition_id}/input/{input_id}/register |
*RegisterRequestAPI* | [**RegisterOutput**](docs/RegisterRequestAPI.md#registeroutput) | **Post** /api/composition/{composition_id}/output/{output_id}/register |
*UnregisterRequestAPI* | [**UnregisterImage**](docs/UnregisterRequestAPI.md#unregisterimage) | **Post** /api/composition/{composition_id}/image/{image_id}/unregister |
*UnregisterRequestAPI* | [**UnregisterInput**](docs/UnregisterRequestAPI.md#unregisterinput) | **Post** /api/composition/{composition_id}/input/{input_id}/unregister |
*UnregisterRequestAPI* | [**UnregisterOutput**](docs/UnregisterRequestAPI.md#unregisteroutput) | **Post** /api/composition/{composition_id}/output/{output_id}/unregister |
*UpdateRequestAPI* | [**RequestKeyframe**](docs/UpdateRequestAPI.md#requestkeyframe) | **Post** /api/composition/{composition_id}/output/{output_id}/request_keyframe |
*UpdateRequestAPI* | [**UpdateOutput**](docs/UpdateRequestAPI.md#updateoutput) | **Post** /api/composition/{composition_id}/output/{output_id}/update |
*WhipWhepAPI* | [**WhepOffer**](docs/WhipWhepAPI.md#whepoffer) | **Post** /api/composition/{composition_id}/whep/{output_id} |
*WhipWhepAPI* | [**WhipOffer**](docs/WhipWhepAPI.md#whipoffer) | **Post** /api/composition/{composition_id}/whip/{input_id} |


## Documentation For Models

- [AacRtpMode](docs/AacRtpMode.md)
- [ApiError](docs/ApiError.md)
- [AudioChannels](docs/AudioChannels.md)
- [AudioMixingStrategy](docs/AudioMixingStrategy.md)
- [AudioScene](docs/AudioScene.md)
- [AudioSceneInput](docs/AudioSceneInput.md)
- [BoxShadow](docs/BoxShadow.md)
- [Component](docs/Component.md)
- [ComponentOneOf](docs/ComponentOneOf.md)
- [ComponentOneOf1](docs/ComponentOneOf1.md)
- [ComponentOneOf2](docs/ComponentOneOf2.md)
- [ComponentOneOf3](docs/ComponentOneOf3.md)
- [ComponentOneOf4](docs/ComponentOneOf4.md)
- [CompositionCreatedResponse](docs/CompositionCreatedResponse.md)
- [CreateCompositionRequest](docs/CreateCompositionRequest.md)
- [EasingFunction](docs/EasingFunction.md)
- [EasingFunctionOneOf](docs/EasingFunctionOneOf.md)
- [EasingFunctionOneOf1](docs/EasingFunctionOneOf1.md)
- [EasingFunctionOneOf2](docs/EasingFunctionOneOf2.md)
- [FontUpload](docs/FontUpload.md)
- [Framerate](docs/Framerate.md)
- [H264EncoderPreset](docs/H264EncoderPreset.md)
- [HlsAudioEncoderOptions](docs/HlsAudioEncoderOptions.md)
- [HlsInput](docs/HlsInput.md)
- [HlsOutput](docs/HlsOutput.md)
- [HlsVideoDecoderOptions](docs/HlsVideoDecoderOptions.md)
- [HlsVideoEncoderOptions](docs/HlsVideoEncoderOptions.md)
- [HlsVideoEncoderOptionsOneOf](docs/HlsVideoEncoderOptionsOneOf.md)
- [HlsVideoEncoderOptionsOneOf1](docs/HlsVideoEncoderOptionsOneOf1.md)
- [HorizontalAlign](docs/HorizontalAlign.md)
- [ImageSpec](docs/ImageSpec.md)
- [ImageSpecOneOf](docs/ImageSpecOneOf.md)
- [ImageSpecOneOf1](docs/ImageSpecOneOf1.md)
- [ImageSpecOneOf2](docs/ImageSpecOneOf2.md)
- [ImageSpecOneOf3](docs/ImageSpecOneOf3.md)
- [ImageSpecOneOf4](docs/ImageSpecOneOf4.md)
- [InputHlsCodec](docs/InputHlsCodec.md)
- [InputMp4Codec](docs/InputMp4Codec.md)
- [InputRtmpCodec](docs/InputRtmpCodec.md)
- [InputRtpAudioOptions](docs/InputRtpAudioOptions.md)
- [InputRtpAudioOptionsOneOf](docs/InputRtpAudioOptionsOneOf.md)
- [InputRtpAudioOptionsOneOf1](docs/InputRtpAudioOptionsOneOf1.md)
- [InputRtpVideoOptions](docs/InputRtpVideoOptions.md)
- [InputStream](docs/InputStream.md)
- [InputWhepVideoOptions](docs/InputWhepVideoOptions.md)
- [InputWhipVideoOptions](docs/InputWhipVideoOptions.md)
- [Interpolation](docs/Interpolation.md)
- [Mp4AudioEncoderOptions](docs/Mp4AudioEncoderOptions.md)
- [Mp4Input](docs/Mp4Input.md)
- [Mp4Output](docs/Mp4Output.md)
- [Mp4VideoDecoderOptions](docs/Mp4VideoDecoderOptions.md)
- [Mp4VideoEncoderOptions](docs/Mp4VideoEncoderOptions.md)
- [Mp4VideoEncoderOptionsOneOf](docs/Mp4VideoEncoderOptionsOneOf.md)
- [OpusEncoderPreset](docs/OpusEncoderPreset.md)
- [OutputEndCondition](docs/OutputEndCondition.md)
- [OutputHlsAudioOptions](docs/OutputHlsAudioOptions.md)
- [OutputHlsVideoOptions](docs/OutputHlsVideoOptions.md)
- [OutputMp4AudioOptions](docs/OutputMp4AudioOptions.md)
- [OutputMp4VideoOptions](docs/OutputMp4VideoOptions.md)
- [OutputRtmpClientAudioOptions](docs/OutputRtmpClientAudioOptions.md)
- [OutputRtmpClientVideoOptions](docs/OutputRtmpClientVideoOptions.md)
- [OutputRtpAudioOptions](docs/OutputRtpAudioOptions.md)
- [OutputRtpVideoOptions](docs/OutputRtpVideoOptions.md)
- [OutputWhepAudioOptions](docs/OutputWhepAudioOptions.md)
- [OutputWhepVideoOptions](docs/OutputWhepVideoOptions.md)
- [OutputWhipAudioOptions](docs/OutputWhipAudioOptions.md)
- [OutputWhipVideoOptions](docs/OutputWhipVideoOptions.md)
- [Overflow](docs/Overflow.md)
- [PixelFormat](docs/PixelFormat.md)
- [PortOrPortRange](docs/PortOrPortRange.md)
- [RegisterInput](docs/RegisterInput.md)
- [RegisterInputOneOf](docs/RegisterInputOneOf.md)
- [RegisterInputOneOf1](docs/RegisterInputOneOf1.md)
- [RegisterInputOneOf2](docs/RegisterInputOneOf2.md)
- [RegisterInputOneOf3](docs/RegisterInputOneOf3.md)
- [RegisterInputOneOf4](docs/RegisterInputOneOf4.md)
- [RegisterInputOneOf5](docs/RegisterInputOneOf5.md)
- [RegisterOutput](docs/RegisterOutput.md)
- [RegisterOutputOneOf](docs/RegisterOutputOneOf.md)
- [RegisterOutputOneOf1](docs/RegisterOutputOneOf1.md)
- [RegisterOutputOneOf2](docs/RegisterOutputOneOf2.md)
- [RegisterOutputOneOf3](docs/RegisterOutputOneOf3.md)
- [RegisterOutputOneOf4](docs/RegisterOutputOneOf4.md)
- [RegisterOutputOneOf5](docs/RegisterOutputOneOf5.md)
- [RescaleMode](docs/RescaleMode.md)
- [Rescaler](docs/Rescaler.md)
- [Resolution](docs/Resolution.md)
- [Response](docs/Response.md)
- [ResponseOneOf](docs/ResponseOneOf.md)
- [ResponseOneOf1](docs/ResponseOneOf1.md)
- [ResponseOneOf2](docs/ResponseOneOf2.md)
- [RtmpClientAudioEncoderOptions](docs/RtmpClientAudioEncoderOptions.md)
- [RtmpClientVideoEncoderOptions](docs/RtmpClientVideoEncoderOptions.md)
- [RtmpInput](docs/RtmpInput.md)
- [RtmpOutput](docs/RtmpOutput.md)
- [RtmpVideoDecoderOptions](docs/RtmpVideoDecoderOptions.md)
- [RtpAudioEncoderOptions](docs/RtpAudioEncoderOptions.md)
- [RtpInput](docs/RtpInput.md)
- [RtpOutput](docs/RtpOutput.md)
- [RtpVideoDecoderOptions](docs/RtpVideoDecoderOptions.md)
- [RtpVideoEncoderOptions](docs/RtpVideoEncoderOptions.md)
- [RtpVideoEncoderOptionsOneOf](docs/RtpVideoEncoderOptionsOneOf.md)
- [RtpVideoEncoderOptionsOneOf1](docs/RtpVideoEncoderOptionsOneOf1.md)
- [RtpVideoEncoderOptionsOneOf2](docs/RtpVideoEncoderOptionsOneOf2.md)
- [ShaderParam](docs/ShaderParam.md)
- [ShaderParamOneOf](docs/ShaderParamOneOf.md)
- [ShaderParamOneOf1](docs/ShaderParamOneOf1.md)
- [ShaderParamOneOf2](docs/ShaderParamOneOf2.md)
- [ShaderParamOneOf3](docs/ShaderParamOneOf3.md)
- [ShaderParamOneOf4](docs/ShaderParamOneOf4.md)
- [ShaderParamStructField](docs/ShaderParamStructField.md)
- [ShaderSpec](docs/ShaderSpec.md)
- [Text](docs/Text.md)
- [TextStyle](docs/TextStyle.md)
- [TextWeight](docs/TextWeight.md)
- [TextWrapMode](docs/TextWrapMode.md)
- [Tiles](docs/Tiles.md)
- [Transition](docs/Transition.md)
- [TransportProtocol](docs/TransportProtocol.md)
- [UnregisterInput](docs/UnregisterInput.md)
- [UnregisterOutput](docs/UnregisterOutput.md)
- [UnregisterRenderer](docs/UnregisterRenderer.md)
- [UpdateOutputRequest](docs/UpdateOutputRequest.md)
- [VerticalAlign](docs/VerticalAlign.md)
- [VideoEncoderBitrate](docs/VideoEncoderBitrate.md)
- [VideoEncoderBitrateOneOf](docs/VideoEncoderBitrateOneOf.md)
- [VideoScene](docs/VideoScene.md)
- [View](docs/View.md)
- [ViewDirection](docs/ViewDirection.md)
- [WhepAudioEncoderOptions](docs/WhepAudioEncoderOptions.md)
- [WhepInput](docs/WhepInput.md)
- [WhepOutput](docs/WhepOutput.md)
- [WhepVideoDecoderOptions](docs/WhepVideoDecoderOptions.md)
- [WhepVideoEncoderOptions](docs/WhepVideoEncoderOptions.md)
- [WhipAudioEncoderOptions](docs/WhipAudioEncoderOptions.md)
- [WhipAudioEncoderOptionsOneOf](docs/WhipAudioEncoderOptionsOneOf.md)
- [WhipAudioEncoderOptionsOneOf1](docs/WhipAudioEncoderOptionsOneOf1.md)
- [WhipInput](docs/WhipInput.md)
- [WhipOutput](docs/WhipOutput.md)
- [WhipVideoDecoderOptions](docs/WhipVideoDecoderOptions.md)
- [WhipVideoEncoderOptions](docs/WhipVideoEncoderOptions.md)
- [WhipVideoEncoderOptionsOneOf](docs/WhipVideoEncoderOptionsOneOf.md)
- [WhipVideoEncoderOptionsOneOf1](docs/WhipVideoEncoderOptionsOneOf1.md)
- [WhipVideoEncoderOptionsOneOf2](docs/WhipVideoEncoderOptionsOneOf2.md)


## Documentation For Authorization


Authentication schemes defined for the API:
### BearerAuth

- **Type**: HTTP Bearer token authentication

Example

```go
auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```


## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`

## Author



Loading