Interface SourcesApiObject<SourceApi>

Type Parameters

SourceApi extends EmptyObject

Hierarchy

SourcesApiObject

Index

Methods

add attachVideo detachVideo list remove

Methods

add

add(config, options?, insertAt?): SourceApi
Parameters
- config: SourceConfig
- Optional options: SourceOptionsWithAttach
- Optional insertAt: number
Returns SourceApi
- Defined in dist/sdk/tmp-typedoc/player-types/packages/sources-api/Types.d.ts:21

attachVideo

attachVideo(source, options?): void
Parameters
- source: SourceApi
- Optional options: AttachOptions
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/sources-api/Types.d.ts:23

detachVideo

detachVideo(source): void
Parameters
- source: SourceApi
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/sources-api/Types.d.ts:24

list

list(): SourceApi[]
Returns SourceApi[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/sources-api/Types.d.ts:20

remove

remove(source): void
Parameters
- source: SourceApi
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/sources-api/Types.d.ts:22

framework-types
- abortable
  - Abortable.d.ts
    - Abortable
    - abortAndWaitForExit
    - forEach
    - isAbortable
    - linkAbortSignal
    - map
    - race
    - rejectAfter
    - resolveAfter
    - rightCompose
    - sequence
    - waitForExit
  - Types.d.ts
    - AbortableCreator
    - CheckChained
    - Head
    - Last
    - Tail
- api-manager
  - ApiManager.d.ts
    - ApiManager
    - Property
  - Errors.d.ts
    - ApiDisposedError
- data-structures
  - MapWithDefault.d.ts
    - MapWithDefault
  - Types.d.ts
    - GenericHashMap
- effect
  - EffectFactory.d.ts
    - createEffectFactory
  - Types.d.ts
    - AnyEffectFactory
    - EffectFactory
- effects
- error
  - FrameworkDisposedError.d.ts
    - FrameworkDisposedError
  - FrameworkError.d.ts
    - FrameworkError
- event-bus
  - EventBus.d.ts
    - EventBus
    - Detach
    - Listener
- execution-context
- package-api
- polyfills
- registry
  - Registry.d.ts
    - Registry
  - RegistryInterface.d.ts
    - RegistryInterface
    - Replacer
- task
  - Task.d.ts
    - bindTask
    - isTask
  - TaskUtils.d.ts
  - Types.d.ts
    - AnyContextTask
    - AnyNamedTask
    - AnyParameterTask
    - AnyTask
    - BoundTask
    - NamedTask
    - Task
    - TaskParam
    - TaskReturn
- thread
  - Thread.d.ts
  - ThreadEventBus.d.ts
- utils
  - debug
    - thread
      - ThreadDecorator.d.ts
        
        ThreadDebugDecorator
  - Awaitable.d.ts
    - Awaitable
  - Deferred.d.ts
    - Deferred
  - StringUtils.d.ts
    - generateId
- index.d.ts
  - WithBaseApi
  - framework
- BaseTypes.d.ts
- Types.d.ts
  - BaseContext
- framework.d.ts
  - WithBaseApi
  - framework
player-types

Generated using TypeDoc