External module scripts/ss/photos

A collection of SSPhoto objects and an index into them

Index

Variables

Functions

Variables

Let CUR_IDX

CUR_IDX: number = 0

Current index into PHOTOS

Const PHOTOS

PHOTOS: SSPhoto[] = []

The array of photos

Functions

addFromSource

addFromSource(photoSource: PhotoSource): Promise<void>

- Defined in scripts/screensaver/ss_photos.ts:194
Add the photos from a PhotoSource

throws

An error if we failed to add the photos

Parameters
- photoSource: PhotoSource
Returns Promise<void>

get

get(idx: number): SSPhoto

- Defined in scripts/screensaver/ss_photos.ts:85
Get the SSPhoto at the given index

Parameters
- idx: number
  
  The index
Returns SSPhoto

The SSPhoto

getCount

getCount(): number

- Defined in scripts/screensaver/ss_photos.ts:64
Get number of photos

Returns number

getCurrentIndex

getCurrentIndex(): number

- Defined in scripts/screensaver/ss_photos.ts:123
Get current index into PHOTOS

Returns number

getIndex

getIndex(photo: SSPhoto): number

- Defined in scripts/screensaver/ss_photos.ts:95
Get the index of a SSPhoto, -1 if not found

Parameters
- photo: SSPhoto
  
  The indexA photo
Returns number

The index, -1 if not found

getNextGooglePhotos

getNextGooglePhotos(num: number, idx: number): SSPhoto[]

- Defined in scripts/screensaver/ss_photos.ts:134
Get the next num of google photos

Parameters
- num: number
  
  max number to get
- idx: number
  
  starting index
Returns SSPhoto[]

array of photos of max length num

getNextUsable

getNextUsable(ignores?: SSPhoto[]): null | SSPhoto

- Defined in scripts/screensaver/ss_photos.ts:105
Get the next SSPhoto that is usable

Parameters
- Default value ignores: SSPhoto[] = []
  
  photos to ignore
Returns null | SSPhoto

An SSPhoto, null if none are usable

hasUsable

hasUsable(): boolean

- Defined in scripts/screensaver/ss_photos.ts:73
Do we have photos that aren't bad

Returns boolean

true if at least one photo is good

incCurrentIndex

incCurrentIndex(): number

- Defined in scripts/screensaver/ss_photos.ts:185
Increment current index into PHOTOS

Returns number

The new current index

loadPhotos

loadPhotos(randomize: boolean): Promise<boolean>

- Defined in scripts/screensaver/ss_photos.ts:36
Load the photos to be used in a Screensaver

Parameters
- randomize: boolean
  
  random sort of photos
Returns Promise<boolean>

true if there is at least one photo

setCurrentIndex

setCurrentIndex(idx: number): void

- Defined in scripts/screensaver/ss_photos.ts:176
Set current index into PHOTOS

Parameters
- idx: number
  
  The index
Returns void

shuffle

shuffle(): void

- Defined in scripts/screensaver/ss_photos.ts:212
Randomize the photos

Returns void

updateGooglePhotoUrls

updateGooglePhotoUrls(photos: IPhoto[]): void

- Defined in scripts/screensaver/ss_photos.ts:156
Update the urls of the given photos that are of the user's Google Photos

Parameters
- photos: IPhoto[]
  
  The photos to update
Returns void

Generated using TypeDoc