Skip to main content

JanusApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
attachToJanusConnectionPOST /janus/attachAttaches to Janus connection
connectToJanusPOST /janus/connectConnects to Janus session
createAndAttachPOST /janus/create-and-attachCreates and attaches to Janus session
createJanusConnectionPOST /janus/createCreates Janus connection
getInfoGET /janus/infoReturns info about Janus server
getListSessionGET /janus/list-sessionsReturns list of current Janus sessions
getSessionGET /janus/sessionReturns info about Janus session
getSessionRawGET /janus/session-rawReturns raw info about Janus session
getStatusGET /janus/get-statusReturns raw info about Janus session
setSettingsPOST /janus/settingsSets janus settings
stopJanusConnectionPOST /janus/stopStops an active Janus session
trickleJanusPOST /janus/trickleTrickles data to Janus server

attachToJanusConnection

Long attachToJanusConnection(sessionId)

Attaches to Janus connection

Parameters

NameTypeDescriptionNotes
sessionIdLongJanus session id to attach to[default to null]

Return type

Long

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

connectToJanus

JanusResponse connectToJanus(ConnectData)

Connects to Janus session

Parameters

NameTypeDescriptionNotes
ConnectDataConnectData

Return type

JanusResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

createAndAttach

SessionData createAndAttach()

Creates and attaches to Janus session

Parameters

This endpoint does not need any parameter.

Return type

SessionData

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

createJanusConnection

Long createJanusConnection()

Creates Janus connection

Parameters

This endpoint does not need any parameter.

Return type

Long

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getInfo

String getInfo()

Returns info about Janus server

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getListSession

List getListSession()

Returns list of current Janus sessions

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getSession

JanusAdminSessionResponse getSession(sessionId)

Returns info about Janus session

Parameters

NameTypeDescriptionNotes
sessionIdLongId of the session[default to null]

Return type

JanusAdminSessionResponse

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getSessionRaw

String getSessionRaw(sessionId)

Returns raw info about Janus session

Parameters

NameTypeDescriptionNotes
sessionIdLongId of the session[default to null]

Return type

String

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getStatus

JanusAdminGetStatusResponse getStatus()

Returns raw info about Janus session

Parameters

This endpoint does not need any parameter.

Return type

JanusAdminGetStatusResponse

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

setSettings

setSettings(timeout, level, timestamps, colors, locking-debug, ref-debug, libnice-debug, no-media-timer)

Sets janus settings

Parameters

NameTypeDescriptionNotes
timeoutIntegerSession timeout[optional] [default to null]
levelIntegerLog level[optional] [default to null]
timestampsBooleanTimestamps[optional] [default to null]
colorsBooleanLog colors[optional] [default to null]
locking-debugBooleanLocking debug[optional] [default to null]
ref-debugBooleanRefcount debug[optional] [default to null]
libnice-debugBooleanLibnice debug[optional] [default to null]
no-media-timerIntegerNo media timer[optional] [default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

stopJanusConnection

stopJanusConnection(SessionData)

Stops an active Janus session

Parameters

NameTypeDescriptionNotes
SessionDataSessionData

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

trickleJanus

trickleJanus(TrickleData)

Trickles data to Janus server

Parameters

NameTypeDescriptionNotes
TrickleDataTrickleData

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /