ExWebRTC.Recorder.S3 (ex_webrtc_recorder v0.4.0)

View Source

ExWebRTC.Recorder and ExWebRTC.Recorder.Converter can optionally upload/download files to/from S3-compatible storage.

To use this functionality, you must add the following dependencies to your project:

  • :ex_aws_s3
  • :ex_aws
  • :sweet_xml
  • an HTTP client (e.g. :hackney)

Summary

Types

override_config()
override_option()

Options described here and here (e.g. :access_key_id, :secret_access_key :scheme, :host, :port, :region).

upload_config()
upload_option()

Options for configuring upload of artifacts to S3-compatible storage.

upload_task_ref()

Reference to a started batch upload task.

Types

override_config()

@type override_config() :: [override_option()]

override_option()

@type override_option() :: {atom(), term()}

Options described here and here (e.g. :access_key_id, :secret_access_key :scheme, :host, :port, :region).

They can be passed in order to override values defined in the application config (or environment variables).

upload_config()

@type upload_config() :: [upload_option() | override_option()]

upload_option()

@type upload_option() ::
  {:bucket_name, String.t()}
  | {:base_path, String.t()}
  | {:upload_manifest, boolean()}

Options for configuring upload of artifacts to S3-compatible storage.

  • :bucket_name (required) - Name of bucket objects will be uploaded to.
  • :base_path - S3 path prefix used for objects uploaded to the bucket. "" by default.
  • :upload_manifest - Whether to upload the manifest file. Defaults to true.

upload_task_ref()

@opaque upload_task_ref()

Reference to a started batch upload task.