@fishjam-cloud/js-server-sdk - v0.29.0
    Preparing search index...

    @fishjam-cloud/js-server-sdk - v0.29.0

    Server-side Node.js SDK for creating and managing Fishjam rooms, peers, agents, and receiving real-time server notifications.

    Client

    CompositionClient
    FishjamClient
    FishjamWSNotifier

    Notifications

    decodeServerNotifications
    verifyWebhookSignature

    Other

    BadRequestException
    CompositionNotFoundException
    FishjamAgent
    FishjamBaseException
    FishjamNotFoundException
    ForbiddenException
    InputNotFoundException
    InvalidFishjamCredentialsException
    MissingFishjamIdException
    OutputNotFoundException
    PeerNotFoundException
    QuotaExceededException
    RecordingNotFoundException
    RendererNotFoundException
    RoomNotFoundException
    ServiceUnavailableException
    StaleSdkException
    UnauthorizedException
    UnknownException
    AgentOutput
    AudioScene
    AudioSceneInput
    BoxShadow
    CreateCompositionRequest
    EasingFunctionBounce
    EasingFunctionCubicBezier
    EasingFunctionLinear
    FishjamExceptionInfo
    Image
    ImageSpecAuto
    ImageSpecGif
    ImageSpecJpeg
    ImageSpecPng
    ImageSpecSvg
    InputStream
    MoqAccess
    MoqAccessConfig
    Mp4Input
    OutputEndCondition
    OutputRtmpClientAudioOptions
    OutputRtmpClientVideoOptions
    OutputWhipAudioOptions
    OutputWhipVideoOptions
    PeerOptionsAgent
    PeerOptionsVapi
    PeerOptionsWebRTC
    RecordingConfig
    RecordingSource
    RegisterInputResponse
    Rescaler
    Resolution
    RoomConfig
    RtmpInput
    RtmpOutput
    SendCompositionEventRequest
    ServerMessage
    StreamerToken
    Text
    Tiles
    Transition
    UnregisterInput
    UnregisterOutput
    UnregisterRenderer
    UpdateOutputRequest
    VideoScene
    View
    ViewerToken
    WhepInput
    WhipAudioEncoderOptionsAny
    WhipAudioEncoderOptionsOpus
    WhipInput
    WhipOutput
    AgentCallbacks
    AgentEvents
    AgentTrack
    AudioChannels
    AudioCodecParameters
    AudioFormat
    AudioMixingStrategy
    AudioSampleRate
    Brand
    ChannelAdded
    ChannelRemoved
    CloseEventHandler
    Component
    Composition
    CompositionConfig
    CompositionId
    EasingFunction
    ErrorEventHandler
    ExpectedAgentEvents
    ExpectedEvents
    FishjamConfig
    HorizontalAlign
    IgnoredEvents
    ImageSpec
    IncomingTrackData
    IncomingTrackImage
    InputId
    Mp4InputDurations
    NotificationEvents
    OpusEncoderPreset
    OutgoingTrackData
    OutputId
    Overflow
    Override
    Peer
    PeerAdded
    PeerConnected
    PeerCrashed
    PeerDeleted
    PeerDisconnected
    PeerId
    PeerMetadataUpdated
    PeerOptions
    PeerStatus
    PeerType
    Recording
    RecordingId
    RecordingStatus
    RecordingStatusChanged
    RegisterInput
    RegisterOutput
    RendererId
    RescaleMode
    Room
    RoomCrashed
    RoomCreated
    RoomDeleted
    RoomId
    RoomType
    ServerNotification
    StreamerConnected
    StreamerDisconnected
    SubscribeMode
    TextStyle
    TextWeight
    TextWrapMode
    Track
    TrackAdded
    TrackForwarding
    TrackForwardingRemoved
    TrackId
    TrackMetadataUpdated
    TrackRemoved
    TrackType
    VadNotification
    VadStatus
    VerticalAlign
    VideoCodec
    ViewDirection
    ViewerConnected
    ViewerDisconnected
    WhipAudioEncoderOptions
    WhipInputTarget
    AudioChannels
    AudioFormat
    AudioMixingStrategy
    AudioSampleRate
    HorizontalAlign
    OpusEncoderPreset
    Overflow
    PeerStatus
    RescaleMode
    RoomType
    ServerMessage
    SubscribeMode
    TextStyle
    TextWeight
    TextWrapMode
    VerticalAlign
    VideoCodec
    ViewDirection

    Settings

    Member Visibility

    On This Page

    Client
    Notifications
    Other
    BadRequestExceptionCompositionNotFoundExceptionFishjamAgentFishjamBaseExceptionFishjamNotFoundExceptionForbiddenExceptionInputNotFoundExceptionInvalidFishjamCredentialsExceptionMissingFishjamIdExceptionOutputNotFoundExceptionPeerNotFoundExceptionQuotaExceededExceptionRecordingNotFoundExceptionRendererNotFoundExceptionRoomNotFoundExceptionServiceUnavailableExceptionStaleSdkExceptionUnauthorizedExceptionUnknownExceptionAgentOutputAudioSceneAudioSceneInputBoxShadowCreateCompositionRequestEasingFunctionBounceEasingFunctionCubicBezierEasingFunctionLinearFishjamExceptionInfoImageImageSpecAutoImageSpecGifImageSpecJpegImageSpecPngImageSpecSvgInputStreamMoqAccessMoqAccessConfigMp4InputOutputEndConditionOutputRtmpClientAudioOptionsOutputRtmpClientVideoOptionsOutputWhipAudioOptionsOutputWhipVideoOptionsPeerOptionsAgentPeerOptionsVapiPeerOptionsWebRTCRecordingConfigRecordingSourceRegisterInputResponseRescalerResolutionRoomConfigRtmpInputRtmpOutputSendCompositionEventRequestServerMessageStreamerTokenTextTilesTransitionUnregisterInputUnregisterOutputUnregisterRendererUpdateOutputRequestVideoSceneViewViewerTokenWhepInputWhipAudioEncoderOptionsAnyWhipAudioEncoderOptionsOpusWhipInputWhipOutputAgentCallbacksAgentEventsAgentTrackAudioChannelsAudioCodecParametersAudioFormatAudioMixingStrategyAudioSampleRateBrandChannelAddedChannelRemovedCloseEventHandlerComponentCompositionCompositionConfigCompositionIdEasingFunctionErrorEventHandlerExpectedAgentEventsExpectedEventsFishjamConfigHorizontalAlignIgnoredEventsImageSpecIncomingTrackDataIncomingTrackImageInputIdMp4InputDurationsNotificationEventsOpusEncoderPresetOutgoingTrackDataOutputIdOverflowOverridePeerPeerAddedPeerConnectedPeerCrashedPeerDeletedPeerDisconnectedPeerIdPeerMetadataUpdatedPeerOptionsPeerStatusPeerTypeRecordingRecordingIdRecordingStatusRecordingStatusChangedRegisterInputRegisterOutputRendererIdRescaleModeRoomRoomCrashedRoomCreatedRoomDeletedRoomIdRoomTypeServerNotificationStreamerConnectedStreamerDisconnectedSubscribeModeTextStyleTextWeightTextWrapModeTrackTrackAddedTrackForwardingTrackForwardingRemovedTrackIdTrackMetadataUpdatedTrackRemovedTrackTypeVadNotificationVadStatusVerticalAlignVideoCodecViewDirectionViewerConnectedViewerDisconnectedWhipAudioEncoderOptionsWhipInputTargetAudioChannelsAudioFormatAudioMixingStrategyAudioSampleRateHorizontalAlignOpusEncoderPresetOverflowPeerStatusRescaleModeRoomTypeServerMessageSubscribeModeTextStyleTextWeightTextWrapModeVerticalAlignVideoCodecViewDirection