Class AlphaSync

constructor

• new AlphaSync(): AlphaSync

• Initializes an instance of AlphaSync class.

  Returns AlphaSync

date_to_items

jobHasBeenCancelled

cameraUrl

• get cameraUrl(): string

• Gets discovered url

  Returns string

  Returns the url discovered via ssdp

discover_avaliable_services

• discover_avaliable_services(): Promise<void>

• Returns Promise<void>

  Returns a promise that resolves when the discovery of services is finished.

  Async

  Discovers the available services on the Sony Alpha Camera.

  Throws

  Will throw an error if the discovery process fails or if the Content Directory service is not found.

download_from_url

• download_from_url(url, savePath): Promise<void>

• Parameters

  • url: string

    The URL of the image to be downloaded.

  • savePath: string

    The path to save the downloaded image.

  Returns Promise<void>

  Returns a promise that resolves when the image is downloaded and saved.

  Async

  Downloads an image from a specific URL.

  Throws

  Will throw an error if the image downloading process fails.

generate_tree

• generate_tree(): Promise<void>

• Returns Promise<void>

  Returns a promise that resolves when the tree generation is finished.

  Async

  Generates the Content Directory tree of the Sony Alpha Camera.

  Throws

  Will throw an error if the Content Directory service is not found or discovered yet.

get_all_between_two_dates

• get_all_between_two_dates(savePath, afterDate, beforeDate): Promise<void>

• Parameters

  • savePath: string

    The path where the fetched images will be saved.

  • afterDate: string[]

    The start date for fetching images, in the format ['YYYY', 'MM', 'DD'].

  • beforeDate: string[]

    The end date for fetching images, in the format ['YYYY', 'MM', 'DD'].

  Returns Promise<void>

  Returns a promise that resolves when all images between the specified dates are fetched and saved.

  Async

  Fetches all images taken between two specific dates.

  Throws

  Will throw an error if the dates are not in the correct format, or if there's an error in the image downloading process.

get_all_images_from_container

• get_all_images_from_container(container, savePath): Promise<void>

• Parameters

  • container: UPNPContainer

    The container to fetch images from.

  • savePath: string

    The path to save the fetched images.

  Returns Promise<void>

  Returns a promise that resolves when all images are fetched and saved.

  Async

  Fetches all images from a specific container in the Content Directory service.

  Throws

  Will throw an error if the image fetching process fails.

get_all_images_from_dict

• get_all_images_from_dict(savePath, dict?): Promise<boolean>

• Parameters

  • savePath: string

    The path where the fetched images will be saved.

  • Optional dict: Record<string, UPNPImage[]>

    An optional dictionary parameter where each key (date string) maps to an array of UPNPImage objects. If not provided, the function will use the date_to_items property of the class.

  Returns Promise<boolean>

  Returns a promise that resolves when all images from the dictionary are fetched and saved. True when job is finished, false when it is interrupted

  Async

  Fetches all images from a provided dictionary, where each date maps to multiple images.

  Throws

  Will throw an error if there are no entries with specific keys in the record or if there's an error in the image downloading process.

get_all_images_in_date

• get_all_images_in_date(date, savePath): Promise<void>

• Parameters

  • date: string

    The date to fetch images from.

  • savePath: string

    The path to save the fetched images.

  Returns Promise<void>

  A promise that resolves when all images are fetched and saved.

  Async

  Fetches all images from a specific date in the Content Directory service.

  Throws

  If the image fetching process fails.

get_all_images_tree

• get_all_images_tree(savePath): Promise<void>

• Parameters

  • savePath: string

    The path to save the fetched images.

  Returns Promise<void>

  Returns a promise that resolves when all images are fetched and saved.

  Async

  Fetches all images as per the Content Directory tree.

  Throws

  Will throw an error if the tree is not created yet. Run the generate_tree method before calling this method.

get_single_image

• get_single_image(savePath): Promise<void>

• Parameters

  • savePath: string

    The path to save the fetched image.

  Returns Promise<void>

  Returns a promise that resolves when the image is fetched and saved.

  Async

  Fetches a single image from the Digital Imaging service.

  Throws

  Will throw an error if the Digital Imaging service is not discovered yet or if the image fetching process fails.

ssdp

• ssdp(): Promise<void>

• Returns Promise<void>

  Returns a promise that resolves when the SSDP process is finished.

  Async

  Initiates the SSDP (Simple Service Discovery Protocol) process for service discovery.

  Throws

  Will throw an error if the SSDP process fails.