Class VideoMessage

constructor

• new VideoMessage(properties?): VideoMessage

• Constructs a new VideoMessage.

  Parameters

  • Optional properties: IVideoMessage

    Properties to set

  Returns VideoMessage

annotations

caption

Optional contextInfo

directPath

fileEncSha256

fileLength

fileSha256

gifAttribution

gifPlayback

height

interactiveAnnotations

jpegThumbnail

mediaKey

mediaKeyTimestamp

mimetype

seconds

staticUrl

streamingSidecar

thumbnailDirectPath

thumbnailEncSha256

thumbnailSha256

url

viewOnce

width

toJSON

• toJSON(): {
      [k: string]: any;
  }

• Converts this VideoMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): VideoMessage

• Creates a new VideoMessage instance using the specified properties.

  Parameters

  • Optional properties: IVideoMessage

    Properties to set

  Returns VideoMessage

  VideoMessage instance

Static decode

• decode(reader, length?): VideoMessage

• Decodes a VideoMessage message from the specified reader or buffer.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  • Optional length: number

    Message length if known beforehand

  Returns VideoMessage

  VideoMessage

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static decodeDelimited

• decodeDelimited(reader): VideoMessage

• Decodes a VideoMessage message from the specified reader or buffer, length delimited.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns VideoMessage

  VideoMessage

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static encode

• encode(message, writer?): Writer

• Encodes the specified VideoMessage message. Does not implicitly verify messages.

  Parameters

  • message: IVideoMessage

    VideoMessage message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static encodeDelimited

• encodeDelimited(message, writer?): Writer

• Encodes the specified VideoMessage message, length delimited. Does not implicitly verify messages.

  Parameters

  • message: IVideoMessage

    VideoMessage message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): VideoMessage

• Creates a VideoMessage message from a plain object. Also converts values to their respective internal types.

  Parameters

  • object: {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

  Returns VideoMessage

  VideoMessage

Static toObject

• toObject(message, options?): {
      [k: string]: any;
  }

• Creates a plain object from a VideoMessage message. Also converts values to other types if specified.

  Parameters

  • message: VideoMessage

    VideoMessage

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

• Verifies a VideoMessage message.

  Parameters

  • message: {
        [k: string]: any;
    }

    Plain object to verify

    • [k: string]: any

  Returns null | string

  null if valid, otherwise the reason why it is not