< Back

New-BTShoulderTapImage

Sun Jan 12, 2020 7:39 pm

NAME New-BTShoulderTapImage



SYNOPSIS

Creates a new ToastShoulderTapImage object.





SYNTAX

New-BTShoulderTapImage -Source <String> [-AlternateText <String>] [-AddImageQuery] [<CommonParameters>]



New-BTShoulderTapImage -SpriteSheet <String> -FrameHeight <UInt32> -FPS <UInt32> [-StartingFrame <UInt32>]

[-AlternateText <String>] [-AddImageQuery] [<CommonParameters>]





DESCRIPTION

The New-BTShoulderTapImage function creates a new ToastShoulderTapImage object.



The image can be a static image or anitmated gif, specified using the Source parameter. It can also be a

spritesheet.



This function is mainly used internally, as it is abstracted away when using New-BurntToastShoulderTap.





PARAMETERS

-Source <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SpriteSheet <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FrameHeight <UInt32>



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-FPS <UInt32>



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-StartingFrame <UInt32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-AlternateText <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AddImageQuery [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

LOTS





OUTPUTS

ToastShoulderTapImage





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$Image = New-BTShoulderTapImage -Source 'https://www.route66sodas.com/wp-content ... /Alert.gif'















RELATED LINKS

https://github.com/Windos/BurntToast/bl ... apImage.md