igpapi — Instagram private API Simulator for Node.js (API reference) 4.19.0
    Preparing search index...

    Interface PostingMusicSearchResultsActions

    The actions of PostingMusicSearchResultsScreen: the methods you call on its handle while the screen is open.

    interface PostingMusicSearchResultsActions {
        listenToTrack: (
            ...args: [
                pick: PostingMusicTrackResult,
                options: PostingMusicPickOptions,
            ],
        ) => Effect<
            ActionValue<undefined>,

                | IgApiError
                | HttpRequestError
                | ReelSongDownloadError
                | ReelAudioMixError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | PostingMediaNotInProcessError,
            never,
        >;
        loadMoreResults: <Self extends ScreenHandle>(
            this: Self,
            ...args: [],
        ) => Effect<
            Self,
            ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
            never,
        >;
        pickTrack: (
            ...args: [pick: PostingMusicTrackResult],
        ) => Effect<
            AssembledHandle<
                "PostingStoryMusicStickerEditor",
                "screen",
                {
                    music: {
                        alacornSessionId: string;
                        browseSessionId: string;
                        startMs: number;
                        track: PostingMusicTrack;
                    };
                },
                PostingStoryMusicStickerEditorActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | IgCheckpointError
                | IgAccountSuspendedError
                | IgAccountDisabledError
                | IgLoginRequiredError
                | IgUserLoggedOutError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
        selectTrack: (
            ...args: [pick: PostingMusicTrackResult],
        ) => Effect<
            AssembledHandle<
                "PostingReelMusicEditor",
                "screen",
                {
                    music: {
                        alacornSessionId: string;
                        browseSessionId: string;
                        originalVolume: number;
                        songVolume: number;
                        startMs: number;
                        track: PostingMusicTrack;
                    };
                    product: | {
                        container: NavigableScreenId;
                        kind: "story-sticker";
                        nullState: string;
                        wire: string;
                    }
                    | {
                        browseSessionId: string;
                        kind: "reel";
                        media: {
                            byteLength: number;
                            durationMs: number;
                            height: number;
                            id: string;
                            kind: "video";
                            mimeType: "video/mp4";
                            width: number;
                        };
                        nullState: string;
                        overlay: NavigableScreenId;
                        wire: string;
                    };
                },
                PostingReelMusicEditorActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | IgApiError
                | HttpRequestError
                | ReelSongDownloadError
                | ReelAudioMixError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError
                | PostingMediaNotInProcessError,
            never,
        >;
        submitQuery: <Self extends ScreenHandle>(
            this: Self,
            ...args: [],
        ) => Effect<
            Self,
            ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
            never,
        >;
        typeQuery: <Self extends ScreenHandle>(
            this: Self,
            ...args: [text: string],
        ) => Effect<
            Self,
            ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
            never,
        >;
    }
    Index

    Properties

    listenToTrack: (
        ...args: [
            pick: PostingMusicTrackResult,
            options: PostingMusicPickOptions,
        ],
    ) => Effect<
        ActionValue<undefined>,

            | IgApiError
            | HttpRequestError
            | ReelSongDownloadError
            | ReelAudioMixError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | PostingMediaNotInProcessError,
        never,
    >

    Taps a song in the Reel's search (pick): the player starts on it and downloads the song for as long as you listen (options.listenMs). Answers the listen.

    loadMoreResults: <Self extends ScreenHandle>(
        this: Self,
        ...args: [],
    ) => Effect<
        Self,
        ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
        never,
    >

    Scrolls the Reel's list down: loads the second page for the text in the field (the story's second page comes with its first). Answers the screen shown again with the longer list.

    pickTrack: (
        ...args: [pick: PostingMusicTrackResult],
    ) => Effect<
        AssembledHandle<
            "PostingStoryMusicStickerEditor",
            "screen",
            {
                music: {
                    alacornSessionId: string;
                    browseSessionId: string;
                    startMs: number;
                    track: PostingMusicTrack;
                };
            },
            PostingStoryMusicStickerEditorActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | IgCheckpointError
            | IgAccountSuspendedError
            | IgAccountDisabledError
            | IgLoginRequiredError
            | IgUserLoggedOutError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps a song in the story's search (pick): sends the selection's tracking and opens the screen that records the song. Answers its handle.

    selectTrack: (
        ...args: [pick: PostingMusicTrackResult],
    ) => Effect<
        AssembledHandle<
            "PostingReelMusicEditor",
            "screen",
            {
                music: {
                    alacornSessionId: string;
                    browseSessionId: string;
                    originalVolume: number;
                    songVolume: number;
                    startMs: number;
                    track: PostingMusicTrack;
                };
                product: | {
                    container: NavigableScreenId;
                    kind: "story-sticker";
                    nullState: string;
                    wire: string;
                }
                | {
                    browseSessionId: string;
                    kind: "reel";
                    media: {
                        byteLength: number;
                        durationMs: number;
                        height: number;
                        id: string;
                        kind: "video";
                        mimeType: "video/mp4";
                        width: number;
                    };
                    nullState: string;
                    overlay: NavigableScreenId;
                    wire: string;
                };
            },
            PostingReelMusicEditorActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | IgApiError
            | HttpRequestError
            | ReelSongDownloadError
            | ReelAudioMixError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError
            | PostingMediaNotInProcessError,
        never,
    >

    Taps Select on the song the Reel's player plays (pick): sends the selection's tracking and opens the Reel's music editor. Answers its handle.

    submitQuery: <Self extends ScreenHandle>(
        this: Self,
        ...args: [],
    ) => Effect<
        Self,
        ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
        never,
    >

    Taps the keyboard's search key: the same pages, marked as submitted. Available in the story's search; the Reel's search fails with ScreenDataError. Answers the screen shown again with the fresh results.

    typeQuery: <Self extends ScreenHandle>(
        this: Self,
        ...args: [text: string],
    ) => Effect<
        Self,
        ScreenDataActionFailure<IgApiError | HttpRequestError | ScreenDataError>,
        never,
    >

    Types in the search field (text): loads the keyword suggestions of each prefix and the matching songs (the Reel's first page). Answers the screen shown again with the fresh results.