ImageProps interface

Package:

@microsoft/teams-js

All properties in ImageProps are optional and have default values in the platform

Extends

MediaProps

Properties

cameraSwitcher	Optional; indicate if user is allowed to move between front and back camera Default value is true
enableFilter	Optional; indicate if image filtering mode is enabled on the selected image Default value is false
imageOutputFormats	Optional; Lets the developer specify the image output formats, more than one can be specified. Default value is Image.
ink	Optional; indicate if inking on the selected Image is allowed or not Default value is true
sources	Optional; Lets the developer specify the media source, more than one can be specified. Default value is both camera and gallery
startMode	Optional; Specify in which mode the camera will be opened. Default value is Photo
textSticker	Optional; indicate if putting text stickers on the selected Image is allowed or not Default value is true

Property Details

cameraSwitcher

Optional; indicate if user is allowed to move between front and back camera Default value is true

cameraSwitcher?: boolean

Property Value

boolean

enableFilter

Optional; indicate if image filtering mode is enabled on the selected image Default value is false

enableFilter?: boolean

Property Value

boolean

imageOutputFormats

Optional; Lets the developer specify the image output formats, more than one can be specified. Default value is Image.

imageOutputFormats?: ImageOutputFormats[]

Property Value

ImageOutputFormats[]

ink

Optional; indicate if inking on the selected Image is allowed or not Default value is true

ink?: boolean

Property Value

boolean

sources

Optional; Lets the developer specify the media source, more than one can be specified. Default value is both camera and gallery

sources?: Source[]

Property Value

Source[]

startMode

Optional; Specify in which mode the camera will be opened. Default value is Photo

startMode?: CameraStartMode

Property Value

CameraStartMode

textSticker

Optional; indicate if putting text stickers on the selected Image is allowed or not Default value is true

textSticker?: boolean

Property Value

boolean