Socket
Book a DemoInstallSign in
Socket

@ashetm/ng-mediastream

Package Overview
Dependencies
Maintainers
0
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ashetm/ng-mediastream

``@ashetm/ng-mediastream`` is a library that simplify manipulation of API ``MediaStream``.

2.0.0
latest
Source
npmnpm
Version published
Weekly downloads
14
133.33%
Maintainers
0
Weekly downloads
 
Created
Source

@ashetm/ng-mediastream

@ashetm/ng-mediastream is a library that simplify manipulation of API MediaStream.

Compatibility Table

Angular Version@ashetm/ng-mediastream VersionSupport
Angular 16 and +@ashetm/ng-mediastream 2.0.0
Angular >= 11.0.0 and < 16.0.0@ashetm/ng-mediastream 1.0.1
Angular ~ 11.2.14@ashetm/ng-mediastream 1.0.0

Install

You can install it with npm:

npm install @ashetm/ng-mediastream

Import

You only need to import provideMediaStream.

...
import { provideMediaStream } from '@ashetm/ng-mediastream';
...
@NgModule({
  ...
  providers: [
    ...
    provideMediaStream(), 
    ...
  ]
  ...
})
export class AppModule { }

API

@ashetm/ng-mediastream exposes the following:

Providers

  • provideMediaStream, that needs to import in order to use the library

Services

MediastreamService

MediastreamService is a service concern all about MediaStream API.

And for methods, there is the following:

  • getCameraDevices() returns Promise<MediaDeviceInfo[]> with camera device list of type MediaDeviceInfo[].

  • getDevices() returns Promise<MediaDeviceInfo[]> with all device list of type MediaDeviceInfo[].

  • getMicrophoneDevices() returns Promise<MediaDeviceInfo[]> with microphone device list of type MediaDeviceInfo[].

  • hasCameraDevices() returns Promise<boolean> boolean value if has at least 1 camera devise.

  • hasMicrophoneDevices() returns Promise<boolean> boolean value if has at least 1 microphone devise.

  • requestCamera(constraints?: MediaTrackConstraints) returns Promise<MediastreamCameraService> that contain instance of MediastreamCameraService (See below), it has 1 optional argument:

  • constraints of type MediaTrackConstraints a configuration for camera.
  • requestCameraAndMicrophone(constraints?: Partial<Record<'audio' | 'video', MediaTrackConstraints>>) returns Promise<MediastreamCameraService> that contain instance of MediastreamCameraService (See below), it has 1 optional argument:
  • constraints of type Partial<Record<'audio' | 'video', MediaTrackConstraints>> a configuration for bot camera and microphone.
  • requestMicrophone(constraints?: MediaTrackConstraints) returns Promise<MediastreamMicrophoneService> that contain instance of MediastreamMicrophoneService (See below), it has 1 optional argument:
  • constraints of type MediaTrackConstraints a configuration for microphone.

MediastreamCameraService

MediastreamCameraService is a service concern all about MediaStream API of camera.

  • currentMediaDevice$ is Observable<MediaDeviceInfo>, it emits MediaDeviceInfo value of current media camera device information.

  • mediastream$ is Observable<MediaStream>, it emits MediaStream value of media stream information.

  • mediastreamConstraints is boolean | MediaTrackConstraints concerning camera configuration value.

For methods, there is the following:

  • disableCamera() returns void, it disables the current camera device.

  • enableCamera() returns void, it enables the current camera device.

  • toggleCamera() returns void, it disables/enables the current camera device.

  • updateCameraDevice(device: MediaDeviceInfo & Record<'kind', 'videoinput'>) returns void, it updates the current camera device with the first argument device: MediaDeviceInfo & Record<'kind', 'videoinput'>.

MediastreamCameraMicrophoneService

MediastreamCameraMicrophoneService is a service concern all about MediaStream API of both camera and microphone at the same time.

  • currentCameraMediaDevice$ is Observable<MediaDeviceInfo>, it emits MediaDeviceInfo value of current media camera device information.

  • currentMicrophoneMediaDevice$ is Observable<MediaDeviceInfo>, it emits MediaDeviceInfo value of current media microphone device information.

  • mediastream$ is Observable<MediaStream>, it emits MediaStream value of media stream information.

  • mediastreamCameraConstraints is boolean | MediaTrackConstraints concerning camera configuration value.

  • mediastreamMicrophoneConstraints is boolean | MediaTrackConstraints concerning microphone configuration value.

For methods, there is the following:

  • disableCamera() returns void, it disables the current camera device.

  • disableMicrophone() returns void, it disables the current microphone device.

  • enableCamera() returns void, it enables the current camera device.

  • enableMicrophone() returns void, it enables the current microphone device.

  • toggleCamera() returns void, it disables/enables the current camera device.

  • toggleMicrophone() returns void, it disables/enables the current microphone device.

  • updateCameraDevice(device: MediaDeviceInfo & Record<'kind', 'videoinput'>) returns void, it updates the current camera device with the first argument device: MediaDeviceInfo & Record<'kind', 'videoinput'>.

  • updateMicrophoneDevice(device: MediaDeviceInfo & Record<'kind', 'audioinput'>) returns void, it updates the current microphone device with the first argument device: MediaDeviceInfo & Record<'kind', 'audioinput'>.

MediastreamMicrophoneService

MediastreamMicrophoneService is a service concern all about MediaStream API of microphone.

  • currentMediaDevice$ is Observable<MediaDeviceInfo>, it emits MediaDeviceInfo value of current media microphone device information.

  • mediastream$ is Observable<MediaStream>, it emits MediaStream value of media stream information.

  • mediastreamConstraints is boolean | MediaTrackConstraints concerning microphone configuration value.

For methods, there is the following:

  • disableMicrophone() returns void, it disables the current microphone device.

  • enableMicrophone() returns void, it enables the current microphone device.

  • toggleMicrophone() returns void, it disables/enables the current microphone device.

  • updateMicrophoneDevice(device: MediaDeviceInfo & Record<'kind', 'audioinput'>) returns void, it updates the current microphone device with the first argument device: MediaDeviceInfo & Record<'kind', 'audioinput'>.

Issue

LOOKING FOR MAINTAINER OR IF THERE IS AN ISSUE OR ANY IDEA TO ADD. PLEASE CREATE ISSUE IN GITHUB REPOSITORY.

Keywords

angular

FAQs

Package last updated on 12 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.