Membrane S3 plugin v0.1.0

View Source Membrane.S3.Sink (Membrane S3 plugin v0.1.0)

Uploads items to an S3 Bucket.

element-options

 Element options

Passed via struct Membrane.S3.Sink.t/0

  • path 

    String.t()

    Required
    The path within your S3 bucket where you'd like to store the resource

  • bucket 

    String.t()

    Required
    S3 bucket

  • chunk_size 

    integer()

    Default value: 5242880
    Chunk size in bytes. Determines how many bytes are written to S3 in one request

  • s3_opts 

    Keyword.t()

    Default value: []
    S3 options

  • aws_config 

    Keyword.t()

    Default value: []
    AWS configuration

  • ex_aws 

    atom()

    Default value: ExAws
    AWS client. Only needed when substituting the default ExAws dependency.

pads

 Pads

input

 :input

Availability :always
Caps :any
Demand mode :manual
Demand unit :bytes
Direction :input
Mode :pull
Name :input

Link to this section Summary

Types

t()

Struct containing options for Membrane.S3.Sink

Functions

membrane_pads()

Returns pads descriptions for Membrane.S3.Sink

options()

Returns description of options available for this module

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Membrane.S3.Sink{
  aws_config: Keyword.t(),
  bucket: String.t(),
  chunk_size: integer(),
  ex_aws: atom(),
  path: String.t(),
  s3_opts: Keyword.t()
}

Struct containing options for Membrane.S3.Sink

Link to this section Functions

Link to this function

membrane_pads()

View Source 
@spec membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]

Returns pads descriptions for Membrane.S3.Sink

Link to this function

options()

View Source 
@spec options() :: keyword()

Returns description of options available for this module