Class DefaultMediaModule

Media management for the Secure Communications Service.

Implements

MediaModule

Index

Constructors

Methods

downloadMediaFile

Constructors

constructor

new DefaultMediaModule(
    sessionManager: SessionManager,
    mediaCredentialManager: MediaCredentialManager,
    secureCommsServiceConfig: {
        advancedSearchEnabled: boolean;
        homeServer: string;
        publicMediaBucket: string;
        region: string;
        roomMediaBucket: string;
        serviceEndpointUrl: string;
    },
): DefaultMediaModule
Parameters
- sessionManager: SessionManager
- mediaCredentialManager: MediaCredentialManager
- secureCommsServiceConfig: {
      advancedSearchEnabled: boolean;
      homeServer: string;
      publicMediaBucket: string;
      region: string;
      roomMediaBucket: string;
      serviceEndpointUrl: string;
  }
Returns DefaultMediaModule
- Defined in src/public/modules/mediaModule.ts:50

Methods

downloadMediaFile

downloadMediaFile(input: DownloadMediaFileInput): Promise<ArrayBuffer>
Downloads media to a file. Use for downloading and sharing media, or for loading animated media like GIFs to display.
Parameters
- input: DownloadMediaFileInput
  Parameters used to download a media file.
Returns Promise<ArrayBuffer>
The file containing the media as an array buffer.
Implementation of MediaModule.downloadMediaFile
- Defined in src/public/modules/mediaModule.ts:58