overwolf.streaming.setBRBImage

Overwolf APIs / overwolf / overwolf / streaming / setBRBImage

function setBRBImage(
  streamId: number,
  image: any,
  backgroundColor: string,
  callback?: CallbackFunction<Result>,
): void;

Set a stream's Be Right Back image.

Parameters

Parameter	Type	Description
`streamId`	`number`	The id of the stream for which to set the Be Right Back image.
`image`	`any`	The image to set, as an IMG object or a URL.
`backgroundColor`	`string`	The color to paint the last game frame with before overlaying the image.
`callback?`	`CallbackFunction`<`Result`>	A callback function to call with success or failure indication.

void