Constructor Detail

• IngressServiceClient

  IngressServiceClient(IngressService service, String apiKey, String secret)

Method Detail

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions, Boolean bypassTranscoding, Boolean enableTranscoding, String url)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions, Boolean bypassTranscoding, Boolean enableTranscoding)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions, Boolean bypassTranscoding)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType, <Error class: unknown class> audioOptions)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> inputType)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity, String participantName)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName, String participantIdentity)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name, String roomName)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• createIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,.,java.lang.Boolean,java.lang.Boolean,java.lang.String)>createIngress(String name)

  Creates a new ingress. Default audio and video options will be used if none is provided.

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions, Boolean bypassTranscoding, Boolean enableTranscoding)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions, Boolean bypassTranscoding)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> audioOptions, <Error class: unknown class> videoOptions)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity, String participantName, <Error class: unknown class> audioOptions)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity, String participantName)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName, String participantIdentity)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name, String roomName)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID, String name)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• updateIngress

  @JvmOverloads() final Call<<Error class: unknown class>> ,.,java.lang.Boolean,java.lang.Boolean)>updateIngress(String ingressID)

  Updates the existing ingress with the given ingressID. Only inactive ingress can be updated

• listIngress

  @JvmOverloads() final Call<List<<Error class: unknown class>>> listIngress(String roomName, String ingressId)

  List ingress

  Parameters:

  roomName - when null or empty, list all rooms.

  ingressId - when set, filters by ingressId

• listIngress

  @JvmOverloads() final Call<List<<Error class: unknown class>>> listIngress(String roomName)

  List ingress

  Parameters:

  roomName - when null or empty, list all rooms.

• listIngress

  @JvmOverloads() final Call<List<<Error class: unknown class>>> listIngress()

  List ingress

• deleteIngress

   final Call<<Error class: unknown class>> deleteIngress(String ingressID)

• create

  @Deprecated(message = "Use IngressServiceClient.createClient()", replaceWith = @ReplaceWith(imports = {"import io.livekit.server.okhttp.OkHttpFactory"}, expression = "IngressServiceClient.createClient(host, apiKey, secret, OkHttpFactory(logging))"))@JvmOverloads() final static IngressServiceClient create(String host, String apiKey, String secret, Boolean logging)

  Create an IngressServiceClient.

• create

  @Deprecated(message = "Use IngressServiceClient.createClient()", replaceWith = @ReplaceWith(imports = {"import io.livekit.server.okhttp.OkHttpFactory"}, expression = "IngressServiceClient.createClient(host, apiKey, secret, OkHttpFactory(logging))"))@JvmOverloads() final static IngressServiceClient create(String host, String apiKey, String secret)

  Create an IngressServiceClient.

• createClient

  @JvmOverloads() final static IngressServiceClient createClient(String host, String apiKey, String secret, Supplier<OkHttpClient> okHttpSupplier)

  Create an IngressServiceClient.

  Parameters:

  okHttpSupplier - provide an OkHttpFactory if you wish to customize the http client (e.g.

• createClient

  @JvmOverloads() final static IngressServiceClient createClient(String host, String apiKey, String secret)

  Create an IngressServiceClient.