3.4.1 Release

3.4.1 Changes

New

• Added deprecation warning/error due to Twitch shutting down the v5 API by the end of February, 2022.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Update

To update from a previous version of StreamXRef, use the command Update-Module StreamXRef in PowerShell.

Install

To install the module from the PowerShell Gallery, use the command Install-Module StreamXRef in PowerShell.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

3.4.0 Release

3.4.0 Changes

Modified

• Switched to 64-bit integers for Video ID numbers for future-proofing. This is assuming that's what Twitch will do once they run out of 32-bit numbers.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Update

To update from a previous version of StreamXRef, use the command Update-Module StreamXRef in PowerShell.

Install

To install the module from the PowerShell Gallery, use the command Install-Module StreamXRef in PowerShell.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

3.3.0 Release

3.3.0 Changes

Modified

• Find-TwitchXRef: Change the name of the 2nd parameter to Target (XRef will still work as an alias).

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternative Installation

You can download and extract the module manually from here for testing or if you don't want to deal with updating PowerShellGet. Load it by using Import-Module path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first if you are on Windows.

3.2.0 Release

3.2.0 Changes

Modified

• Videos can now be specified using the shorthand format "v/..." instead of requiring the full "twitch.tv/videos/...".

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternative Installation

You can download and extract the module manually from here for testing or if you don't want to deal with updating PowerShellGet. Load it by using Import-Module path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first if you are on Windows.

3.1.1 Release

3.1.1 Changes

Modified

• Minor clarification for release notes in module manifest.
• Version updated to 3.1.1 due to 3.1.0 having already been pushed to PS Gallery.

3.1.0 Changes

New

• Enable-Persistence: Added options for compressing and excluding clip mapping.
  • Parameters Compress and ExcludeClipMapping (alias:NoMapping or ECM).
  • Use Force parameter to override existing formatting settings. If not specified, it will use the existing formatting from the file (or the restored backup if Disable-Persistence was run without the Remove parameter).

Modified

• Enable-Persistence: Join 'datacache.json' to path if environment variable XRefPersistPath is not a *.json file.
• Import: Fixed counter only showing values from last file if pipelined multiple paths.
• Export: File now includes a config object for metadata.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternative Installation

You can download and extract the module manually from here for testing or if you don't want to deal with updating PowerShellGet. Load it by using Import-Module path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first if you are on Windows.

3.0.0 Release

This is the full release of StreamXRef version 3.0.0!

The main cmdlet is Find-TwitchXRef (which has a default alias of txr).
Helper cmdlets are Export-XRefData, Import-XRefData, Clear-XRefData, Enable-XRefPersistence, and Disable-XRefPersistence.

Documentation

• Find-TwitchXRef
• Export-XRefData
• Import-XRefData
• Clear-XRefData
• Enable-XRefPersistence
• Disable-XRefPersistence

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternative Installation

You can download and extract the module manually from here for testing or if you don't want to deal with updating PowerShellGet. Load it by using Import-Module path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first if you are on Windows.

3.0.0-beta9

3.0.0-beta9 Changes

• Fixed data persistence not working (#6).
• Added the ability to override the path used for Enable-XRefPersistence by specifying a path to a "*.json" file in the $Env:XRefPersistPath environment variable.
• Updated documentation.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef -AllowPreRelease.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternatively, you can download and extract the module manually from here for testing. Load it by using Import-Module ./path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first.

3.0.0-beta8

3.0.0-beta8 Changes

• Improved data type enforcement (data cache layout is now specified in the class library).
• Added Persist parameter to Import-XRefData to enable emitting an event when new data is imported.
• The "XRefNewDataAdded" event now specifies whether the sender is Find-TwitchXRef or Import-XRefData.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef -AllowPreRelease.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternatively, you can download and extract the module manually from here for testing. Load it by using Import-Module ./path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first.

v3.0.0-beta7 (hotfix)

HOTFIX

• Fix broken persistence function and loading. (If you somehow downloaded the earlier v3.0.0-beta6 version, update and run Disable-XRefPersistence -Remove) (73a2a32)

---

From 3.0.0-beta6

• Results are now cached for Clip to Username lookups.
• Added built-in functions for automatically persisting cached data to disk and auto-loading it upon module load (Enable-XRefPersistence and Disable-XRefPersistence). Note that, on load, any clip or video entries older than 60 days will be removed (which matches Twitch's default video retention period for broadcast archives).

Breaking Changes

• All instances of "XRefLookupData" have been changed to "XRefData" (so something like Clear-XRefLookupData is now Clear-XRefData).
• The Clear function now uses -Name to specify individual caches to clear.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef -AllowPreRelease.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternatively, you can download and extract the module manually from here for testing. Load it by using Import-Module ./path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first.

v3.0.0-beta6

• Results are now cached for Clip to Username lookups.
• Added built-in functions for automatically persisting cached data to disk and auto-loading it upon module load (Enable-XRefPersistence and Disable-XRefPersistence). Note that, on load, any clip or video entries older than 60 days will be removed (which matches Twitch's default video retention period for broadcast archives).

BREAKING CHANGES:

• All instances of "XRefLookupData" have been changed to "XRefData" (so something like Clear-XRefLookupData is now Clear-XRefData).
• The Clear function now uses -Name to specify individual caches to clear.

---

You will need to have a valid API key (Client ID), which you can obtain from the Twitch Developer Dashboard.

---

Recommended Installation

Install the module from the PowerShell Gallery using Install-Module StreamXRef -AllowPreRelease.

For Windows PowerShell 5.1

You will probably need to update your PowerShellGet module, although I would strongly recommend installing the latest version of PowerShell instead.

Alternatively, you can download and extract the module manually from here for testing. Load it by using Import-Module ./path/to/directory/of/StreamXRef (make sure there's no ending slash if using PS 5.1). You will probably have to run Unblock-File on the files first.