Skip to content

Media

Photos, video, audio, camera, and image processing.

import Media;

addFrameToGif

Adds an image to the existing animated GIF passed as input. If no GIF is passed as input, a new animated GIF is created.

addFrameToGif(WFImage: Any, WFInputGIF: Any, WFGIFDelayTime: Number, WFGIFAutoSize: Boolean, WFGIFManualSizeWidth: Number, WFGIFManualSizeHeight: Number) -> Any
ParameterTypeDefault
WFImageAny
WFInputGIFAny
WFGIFDelayTimeNumber0.25
WFGIFAutoSizeBooleantrue
WFGIFManualSizeWidthNumber
WFGIFManualSizeHeightNumber

Shortcuts action: is.workflow.actions.addframetogif

addToPlayingNext

Adds the music passed as input to your Playing Next queue.

addToPlayingNext(WFWhenToPlay: Text, WFMusic: Any)
ParameterTypeDefault
WFWhenToPlayText"Next"
WFMusicAny

Shortcuts action: is.workflow.actions.addmusictoupnext

addToPlaylist

Adds the items passed as input to the specified playlist.

addToPlaylist(WFPlaylistName: Text, WFInput: Any) -> Any
ParameterTypeDefault
WFPlaylistNameText
WFInputAny

Shortcuts action: is.workflow.actions.addtoplaylist

changePlaybackDestination

Changes the current playback destination. Use this action to route audio to AirPods, Bluetooth speakers, HomePod, or other AirPlay devices. Optionally, this action can add or remove devices from a group, so you can route audio to multiple devices at once.

changePlaybackDestination(WFMediaRouteOperation: Text, WFMediaRoute: Text)
ParameterTypeDefault
WFMediaRouteOperationText"Set"
WFMediaRouteText"Local"

When attempting to add a device that does not support groups, all other devices are removed as playback destinations first.

Shortcuts action: is.workflow.actions.setplaybackdestination

clearPlayingNext

Clears all the music in your Playing Next queue.

clearPlayingNext()

Shortcuts action: is.workflow.actions.clearupnext

combineImages

Combines the images passed into the action horizontally, vertically, or in a grid.

combineImages(WFImageCombineMode: Text, WFImageCombineSpacing: Number, WFInput: Any) -> Any
ParameterTypeDefault
WFImageCombineModeText"Horizontally"
WFImageCombineSpacingNumber0
WFInputAny

Shortcuts action: is.workflow.actions.image.combine

convertImage

Converts the images passed into the action to the specified image format.

convertImage(WFImageFormat: Text, WFImageCompressionQuality: Number, WFImagePreserveMetadata: Boolean, WFInput: Any) -> Any
ParameterTypeDefault
WFImageFormatText"JPEG"
WFImageCompressionQualityNumber0.75
WFImagePreserveMetadataBooleantrue
WFInputAny

Shortcuts action: is.workflow.actions.image.convert

createPhotoAlbum

Creates a new album in the Photos app, including the specified photos and videos.

createPhotoAlbum(AlbumName: Text, WFInput: Any) -> Any
ParameterTypeDefault
AlbumNameText
WFInputAny

Shortcuts action: is.workflow.actions.photos.createalbum

createPlaylist

Creates a new playlist in the Music app, adding any items passed as input to the new playlist.

createPlaylist(WFPlaylistName: Text, WFPlaylistAuthor: Text, WFPlaylistDescription: Text, WFPlaylistItems: Any) -> Any
ParameterTypeDefault
WFPlaylistNameText
WFPlaylistAuthorText
WFPlaylistDescriptionText
WFPlaylistItemsAny

Shortcuts action: is.workflow.actions.createplaylist

cropImage

Crops images to a smaller rectangle.

cropImage(WFInput: Any, WFImageCropPosition: Text, WFImageCropX: Number, WFImageCropY: Number, WFImageCropWidth: Number, WFImageCropHeight: Number) -> Any
ParameterTypeDefault
WFInputAny
WFImageCropPositionText"Center"
WFImageCropXNumber
WFImageCropYNumber
WFImageCropWidthNumber100
WFImageCropHeightNumber100

Shortcuts action: is.workflow.actions.image.crop

deletePhotos

Deletes the photos passed as input from the device's photo library. This action asks for confirmation before performing the deletion.

deletePhotos()

Shortcuts action: is.workflow.actions.deletephotos

encodeMedia

Re-encodes the media passed as input at the specified size, optionally converting to audio.

encodeMedia(WFMedia: Any, WFMediaAudioOnly: Boolean, WFMediaAudioFormat: Text, WFMediaSize: Text, WFMediaSpeed: Text, WFMediaPreserveTransparency: Boolean, WFMediaCustomSpeed: Number, Metadata: Any, WFMetadataTitle: Text, WFMetadataArtist: Text, WFMetadataAlbum: Text, WFMetadataGenre: Text, WFMetadataYear: Text, WFMetadataArtwork: Any) -> Any
ParameterTypeDefault
WFMediaAny
WFMediaAudioOnlyBooleanfalse
WFMediaAudioFormatText"M4A"
WFMediaSizeText"Passthrough"
WFMediaSpeedText"Normal"
WFMediaPreserveTransparencyBooleanfalse
WFMediaCustomSpeedNumber
MetadataAny
WFMetadataTitleText
WFMetadataArtistText
WFMetadataAlbumText
WFMetadataGenreText
WFMetadataYearText
WFMetadataArtworkAny

Shortcuts action: is.workflow.actions.encodemedia

filterImages

filterImages()

Shortcuts action: is.workflow.actions.filter.images

finderConvertImage

finderConvertImage(WFPreserveMetadata: Boolean, WFImage: Any, WFFileFormat: Text, WFSize: Text) -> Any
ParameterTypeDefault
WFPreserveMetadataBoolean
WFImageAny
WFFileFormatText"JPEG"
WFSizeText"Small"

Shortcuts action: is.workflow.actions.image.convert.finder

findGiphyGifs

Finds GIFs representing the provided text, using Giphy.

findGiphyGifs(WFGiphyQuery: Text, WFGiphyShowPicker: Boolean, WFGiphyLimit: Number, WFGiphySelectMultiple: Boolean) -> Any
ParameterTypeDefault
WFGiphyQueryText
WFGiphyShowPickerBooleantrue
WFGiphyLimitNumber1
WFGiphySelectMultipleBoolean

Powered by Giphy (giphy.com)

Shortcuts action: is.workflow.actions.giphy

findMusic

findMusic()

Shortcuts action: is.workflow.actions.filter.music

findPhotos

findPhotos()

Shortcuts action: is.workflow.actions.filter.photos

findPodcasts

Finds podcasts in the Apple Podcasts catalog, returning the items that match the specified search terms.

findPodcasts(WFSearchTerm: Text, WFAttribute: Text, WFEntity: Text, WFCountry: Text, WFItemLimit: Number) -> Any
ParameterTypeDefault
WFSearchTermText
WFAttributeText
WFEntityText
WFCountryText
WFItemLimitNumber25

Shortcuts action: is.workflow.actions.searchpodcasts

flipImage

Reverses the direction of images either horizontally or vertically.

flipImage(WFImageFlipDirection: Text, WFInput: Any) -> Any
ParameterTypeDefault
WFImageFlipDirectionText"Horizontal"
WFInputAny

Shortcuts action: is.workflow.actions.image.flip

followPodcast

Follows podcasts or podcast feed URLs passed into the action.

followPodcast(WFInput: Text)
ParameterTypeDefault
WFInputText

Shortcuts action: is.workflow.actions.podcasts.subscribe

getCurrentSong

Returns the song that is currently playing in the Music app, if any.

getCurrentSong(Subject: Text) -> Any
ParameterTypeDefault
SubjectText"Current Song"

Shortcuts action: is.workflow.actions.getcurrentsong

getDetailsOfImages

getDetailsOfImages()

Shortcuts action: is.workflow.actions.properties.images

getDetailsOfItunesArtist

getDetailsOfItunesArtist()

Shortcuts action: is.workflow.actions.properties.itunesartist

getDetailsOfItunesProduct

getDetailsOfItunesProduct()

Shortcuts action: is.workflow.actions.properties.itunesstore

getDetailsOfMusic

getDetailsOfMusic()

Shortcuts action: is.workflow.actions.properties.music

getDetailsOfPodcast

getDetailsOfPodcast()

Shortcuts action: is.workflow.actions.properties.podcastshow

getDetailsOfPodcastEpisode

getDetailsOfPodcastEpisode()

Shortcuts action: is.workflow.actions.properties.podcast

getDetailsOfShazam

getDetailsOfShazam()

Shortcuts action: is.workflow.actions.properties.shazam

getEpisodesOfPodcast

Returns a list of episodes from a podcast show.

getEpisodesOfPodcast(WFInput: Text) -> Any
ParameterTypeDefault
WFInputText

Shortcuts action: is.workflow.actions.getepisodesforpodcast

getFramesFromImage

Splits an animated GIF or a photo burst into individual frames.

getFramesFromImage(WFImage: Any) -> Any
ParameterTypeDefault
WFImageAny

Shortcuts action: is.workflow.actions.getframesfromimage

getLastImport

Gets the most recent photo import from the Photos app.

getLastImport() -> Any

Shortcuts action: is.workflow.actions.getlatestphotoimport

getLatestBursts

Gets the most recent burst photos from the photo library.

getLatestBursts(WFGetLatestPhotoCount: Number) -> Any
ParameterTypeDefault
WFGetLatestPhotoCountNumber1

Shortcuts action: is.workflow.actions.getlatestbursts

getLatestLivePhotos

Gets the most recent Live Photos from the photo library.

getLatestLivePhotos(WFGetLatestPhotoCount: Number) -> Any
ParameterTypeDefault
WFGetLatestPhotoCountNumber1

Shortcuts action: is.workflow.actions.getlatestlivephotos

getLatestPhotos

Gets the most recent photos from the photo library.

getLatestPhotos(WFGetLatestPhotoCount: Number, WFGetLatestPhotosActionIncludeScreenshots: Boolean) -> Any
ParameterTypeDefault
WFGetLatestPhotoCountNumber1
WFGetLatestPhotosActionIncludeScreenshotsBooleantrue

Shortcuts action: is.workflow.actions.getlastphoto

getLatestScreenshots

Gets the most recent screenshots from the photo library.

getLatestScreenshots(WFGetLatestPhotoCount: Number) -> Any
ParameterTypeDefault
WFGetLatestPhotoCountNumber1

Shortcuts action: is.workflow.actions.getlastscreenshot

getLatestVideos

Gets the most recent videos from the photo library.

getLatestVideos(WFGetLatestPhotoCount: Number) -> Any
ParameterTypeDefault
WFGetLatestPhotoCountNumber1

Shortcuts action: is.workflow.actions.getlastvideo

getPlaylist

Gets every song in the specified playlist.

getPlaylist(WFPlaylistName: Text) -> Any
ParameterTypeDefault
WFPlaylistNameText

Shortcuts action: is.workflow.actions.get.playlist

getPodcastsFromLibrary

Gets a list of all shows in your Podcast library.

getPodcastsFromLibrary() -> Any

Shortcuts action: is.workflow.actions.getpodcastsfromlibrary

handOffPlayback

Hands off Music or Podcasts playback between two devices.

handOffPlayback(WFSourceMediaRoute: Text, WFDestinationMediaRoute: Text)
ParameterTypeDefault
WFSourceMediaRouteText
WFDestinationMediaRouteText

Shortcuts action: is.workflow.actions.handoffplayback

importAudioFilesIntoMusic

Imports audio files into Music and compresses them with the chosen encoder.

importAudioFilesIntoMusic(WFInput: Any, WFImportAudioFilesReencode: Boolean, WFImportAudioFilesEncoder: Text) -> Any
ParameterTypeDefault
WFInputAny
WFImportAudioFilesReencodeBooleanfalse
WFImportAudioFilesEncoderText"Default"

Shortcuts action: is.workflow.actions.importaudiofiles

makeGif

Creates an animated GIF from the images or video passed into the action.

makeGif(WFMakeGIFActionDelayTime: Number, WFMakeGIFActionLoopEnabled: Boolean, WFMakeGIFActionLoopCount: Number, WFMakeGIFActionAutoSize: Boolean, WFMakeGIFActionManualSizeWidth: Number, WFMakeGIFActionManualSizeHeight: Number, WFInput: Any) -> Any
ParameterTypeDefault
WFMakeGIFActionDelayTimeNumber0.2
WFMakeGIFActionLoopEnabledBooleantrue
WFMakeGIFActionLoopCountNumber
WFMakeGIFActionAutoSizeBooleantrue
WFMakeGIFActionManualSizeWidthNumber
WFMakeGIFActionManualSizeHeightNumber
WFInputAny

Shortcuts action: is.workflow.actions.makegif

makeVideoFromGif

Converts an animated GIF into a video.

makeVideoFromGif(WFMakeVideoFromGIFActionLoopCount: Number, WFInputGIF: Any) -> Any
ParameterTypeDefault
WFMakeVideoFromGIFActionLoopCountNumber1
WFInputGIFAny

Shortcuts action: is.workflow.actions.makevideofromgif

markup

Edits an image or PDF with Markup.

markup(WFDocument: Any) -> Any
ParameterTypeDefault
WFDocumentAny

Shortcuts action: is.workflow.actions.avairyeditphoto

maskImage

Applies a mask to each image passed into the action. For example, you can cut images into a rounded rectangle, ellipse or icon shape, or provide a custom alpha mask.

maskImage(WFInput: Any, WFMaskType: Text, WFMaskCornerRadius: Number, WFCustomMaskImage: Any) -> Any
ParameterTypeDefault
WFInputAny
WFMaskTypeText"Rounded Rectangle"
WFMaskCornerRadiusNumber
WFCustomMaskImageAny

Shortcuts action: is.workflow.actions.image.mask

overlayImage

Overlays an image on top of another image.

overlayImage(WFImage: Any, WFInput: Any, WFShouldShowImageEditor: Boolean, WFImagePosition: Text, WFImageWidth: Number, WFImageHeight: Number, WFImageX: Number, WFImageY: Number, WFRotation: Number, WFOverlayImageOpacity: Number) -> Any
ParameterTypeDefault
WFImageAny
WFInputAny
WFShouldShowImageEditorBooleantrue
WFImagePositionText"Center"
WFImageWidthNumber
WFImageHeightNumber
WFImageXNumber
WFImageYNumber
WFRotationNumber0
WFOverlayImageOpacityNumber100

Shortcuts action: is.workflow.actions.overlayimageonimage

overlayText

Overlays text onto the image passed as input.

overlayText(WFText: Text, WFImage: Any, WFTextPosition: Text, WFTextX: Number, WFPercentageTextX: Number, WFTextY: Number, WFPercentageTextY: Number, WFTextOffset: Number, WFPercentageTextOffset: Number, WFFont: Text, WFFontSize: Number, WFPercentageFontSize: Number, WFTextAlignment: Text, WFTextColor: Text, WFTextRotation: Number, WFTextOutlineEnabled: Boolean, WFTextStrokeWidth: Number, WFPercentageTextStrokeWidth: Number, WFTextStrokeColor: Text, WFTextBoxWidth: Number, WFPercentageTextBoxWidth: Number, WFSizingMethod: Text) -> Any
ParameterTypeDefault
WFTextText
WFImageAny
WFTextPositionText"Center"
WFTextXNumber
WFPercentageTextXNumber
WFTextYNumber
WFPercentageTextYNumber
WFTextOffsetNumber0
WFPercentageTextOffsetNumber0.1
WFFontText
WFFontSizeNumber36
WFPercentageFontSizeNumber0.1
WFTextAlignmentText"Center"
WFTextColorText
WFTextRotationNumber0
WFTextOutlineEnabledBooleanfalse
WFTextStrokeWidthNumber0
WFPercentageTextStrokeWidthNumber0.1
WFTextStrokeColorText
WFTextBoxWidthNumber
WFPercentageTextBoxWidthNumber0.8
WFSizingMethodText"Proportional"

Shortcuts action: is.workflow.actions.overlaytext

play/pause

Plays or pauses the currently playing media.

play/pause(WFPlayPauseBehavior: Text, WFMediaRoute: Text)
ParameterTypeDefault
WFPlayPauseBehaviorText"Play/Pause"
WFMediaRouteText"Local"

Shortcuts action: is.workflow.actions.pausemusic

playMusic

Plays music using the Music app.

playMusic(WFMediaItems: Any, WFPlayMusicActionShuffle: Text, WFPlayMusicActionRepeat: Text)
ParameterTypeDefault
WFMediaItemsAny
WFPlayMusicActionShuffleText
WFPlayMusicActionRepeatText

Shortcuts action: is.workflow.actions.playmusic

playPodcast

Plays a podcast using the Podcasts app. If no podcast is selected, resumes playback.

playPodcast(WFPodcastShow: Text, WFPodcastPlaybackOrder: Text)
ParameterTypeDefault
WFPodcastShowText
WFPodcastPlaybackOrderText

Shortcuts action: is.workflow.actions.playpodcast

playSound

Plays the audio file passed as input, or a default notification sound if no audio file was passed.

playSound(WFInput: Any)
ParameterTypeDefault
WFInputAny

Shortcuts action: is.workflow.actions.playsound

recognizeMusic

Uses the microphone to listen to and identify nearby media.

recognizeMusic(WFShazamMediaActionShowWhenRun: Boolean, WFShazamMediaActionErrorIfNotRecognized: Boolean) -> Any
ParameterTypeDefault
WFShazamMediaActionShowWhenRunBooleantrue
WFShazamMediaActionErrorIfNotRecognizedBooleantrue

Shortcuts action: com.apple.musicrecognition.RecognizeMusicIntent

recordAudio

Uses the microphone to record audio.

recordAudio(WFRecordingCompression: Text, WFRecordingStart: Text, WFRecordingEnd: Text, WFRecordingTimeInterval: Number) -> Any
ParameterTypeDefault
WFRecordingCompressionText"Normal"
WFRecordingStartText"On Tap"
WFRecordingEndText"On Tap"
WFRecordingTimeIntervalNumber

Shortcuts action: is.workflow.actions.recordaudio

removeFromPhotoAlbum

Removes the photos or videos passed as input from the specified photo album.

removeFromPhotoAlbum(WFRemoveAlbumSelectedGroup: Text, WFInput: Any) -> Any
ParameterTypeDefault
WFRemoveAlbumSelectedGroupText
WFInputAny

Shortcuts action: is.workflow.actions.removefromalbum

removeImageBackground

Removes the background from an image, keeping the subjects.

removeImageBackground(WFCropToBounds: Boolean, WFInput: Any) -> Any
ParameterTypeDefault
WFCropToBoundsBooleanfalse
WFInputAny

Shortcuts action: is.workflow.actions.image.removebackground

resizeImage

Scales images to a particular width and height.

resizeImage(WFImageResizeKey: Text, WFImageResizeWidth: Number, WFImageResizeHeight: Number, WFImageResizePercentage: Number, WFImageResizeLength: Number, WFImage: Any) -> Any
ParameterTypeDefault
WFImageResizeKeyText"Size"
WFImageResizeWidthNumber640
WFImageResizeHeightNumber
WFImageResizePercentageNumber
WFImageResizeLengthNumber
WFImageAny

If the width or height is not set, that dimension is automatically calculated to maintain the original image's aspect ratio.

Shortcuts action: is.workflow.actions.image.resize

rotateImage/video

Turns an image or video clockwise by a particular number of degrees.

rotateImage/video(WFImageRotateAmount: Number, WFImage: Any) -> Any
ParameterTypeDefault
WFImageRotateAmountNumber90
WFImageAny

Shortcuts action: is.workflow.actions.image.rotate

saveToPhotos

Adds the photos and videos passed as input to the specified photo album.

saveToPhotos(WFCameraRollSelectedGroup: Text, WFInput: Any) -> Any
ParameterTypeDefault
WFCameraRollSelectedGroupText
WFInputAny

If a photo passed as input is already in the specified album, the photo will be duplicated.

Shortcuts action: is.workflow.actions.savetocameraroll

seek

Seek to a specific time, or forward and backward by some duration, in the currently playing media.

seek(WFSeekBehavior: Text, WFTimeInterval: Number, WFMediaRoute: Text)
ParameterTypeDefault
WFSeekBehaviorText"To Time"
WFTimeIntervalNumber
WFMediaRouteText"Local"

Shortcuts action: is.workflow.actions.seek

selectMusic

Prompts to select music from your local music library.

selectMusic(WFExportSongActionSelectMultiple: Boolean) -> Any
ParameterTypeDefault
WFExportSongActionSelectMultipleBoolean

Shortcuts action: is.workflow.actions.exportsong

selectPhotos

Prompts to choose photos and videos from your photo library.

selectPhotos(WFPhotoPickerTypes: Text, WFSelectMultiplePhotos: Boolean) -> Any
ParameterTypeDefault
WFPhotoPickerTypesTextImages,Live Photos,Videos
WFSelectMultiplePhotosBoolean

Shortcuts action: is.workflow.actions.selectphoto

shazamIt

Uses the microphone to listen to and identify nearby media.

shazamIt(WFShazamMediaActionShowWhenRun: Boolean, WFShazamMediaActionErrorIfNotRecognized: Boolean) -> Any
ParameterTypeDefault
WFShazamMediaActionShowWhenRunBooleantrue
WFShazamMediaActionErrorIfNotRecognizedBooleantrue

Shortcuts action: is.workflow.actions.shazamMedia

skipBack

Skips to the previous song in the current music queue.

skipBack(WFSkipBackBehavior: Text, WFMediaRoute: Text)
ParameterTypeDefault
WFSkipBackBehaviorText"Beginning"
WFMediaRouteText"Local"

Shortcuts action: is.workflow.actions.skipback

skipForward

Skips to the next song in the current music queue.

skipForward(WFMediaRoute: Text)
ParameterTypeDefault
WFMediaRouteText"Local"

Shortcuts action: is.workflow.actions.skipforward

takePhoto

Uses the camera to take photos.

takePhoto(WFCameraCaptureShowPreview: Boolean, WFPhotoCount: Number, WFCameraCaptureDevice: Text) -> Any
ParameterTypeDefault
WFCameraCaptureShowPreviewBooleantrue
WFPhotoCountNumber1
WFCameraCaptureDeviceText"Back"

Shortcuts action: is.workflow.actions.takephoto

takeVideo

Uses the camera to take a video clip.

takeVideo(WFCameraCaptureDevice: Text, WFCameraCaptureQuality: Text, WFRecordingStart: Text) -> Any
ParameterTypeDefault
WFCameraCaptureDeviceText"Back"
WFCameraCaptureQualityText"High"
WFRecordingStartText"Immediately"

Shortcuts action: is.workflow.actions.takevideo

trimMedia

Presents a view allowing you to trim the media passed into the action.

trimMedia(WFInputMedia: Any) -> Any
ParameterTypeDefault
WFInputMediaAny

Shortcuts action: is.workflow.actions.trimvideo